<gglConnection variable>.ListContact (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Possible error cases:

See also

<gglConnection variable>.ListContact (Function)

In french: <Variable gglConnexion>.ListeContact

Retrieves the list of contacts associated with the specified Google account.

Example

// Connection
Cnt is gglConnection
...
// Retrieves all the contacts
arrContacts is array of 0 gglContact = Cnt.ListContact()

// Example with 10 contacts per page:
// First page
// Retrieves all the contacts, with a maximum of 10 contacts, starting from index 1
arrContacts = Cnt.ListContact("", 1, 10)
// Second page
// Retrieves all the contacts, with a maximum of 10 contacts, starting from index 11
arrContacts = Cnt.ListContact("", 11, 10)
// Browse the contacts
MyContact is dynamic gglContact
FOR EACH MyContact OF arrContacts
Trace(MyContact..Name)
END

Syntax

<Result> = <Google connection>.ListContact([<Group of contacts> [, <First element> [, <Maximum number of contacts>]]])

<Result>: Array of gglContact variables

Array of gglContact variables.

<Google connection>: gglConnection variable

Name of the gglConnection variable to use. This connection was validated by <gglConnection variable>.Connect.
Versions 20 and later
Caution: the properties of the gglConnection variable must be revised for the OAuth 2.0 authentication.
New in version 20
Caution: the properties of the gglConnection variable must be revised for the OAuth 2.0 authentication.
Caution: the properties of the gglConnection variable must be revised for the OAuth 2.0 authentication.

<Group of contacts>: Optional Unicode character string

Name or identifier of the group of contacts to list. If this parameter corresponds to an empty string (""), all the groups are listed. This parameter corresponds to an empty string by default.

<First element>: Optional integer

Number of the first contact to retrieve (1 by default). This parameter must be greater than or equal to 1.

<Maximum number of contacts>: Optional integer

Maximum number of contacts to retrieve (0 by default). If this parameter corresponds to 0, the maximum number of contacts is unlimited. This parameter must be greater than or equal to 0.

Remarks

Possible error cases:

The Internet connection is not valid.
The authentication was not performed properly.
The XML response of the server cannot be read.

To find out whether an error occurred, use the ErrorOccurred variable.

Component : wd240ggl.dll