<gglConnection variable>.GetCalendar (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Possible error cases:

See also

<gglConnection variable>.GetCalendar (Function)

In french: <Variable gglConnexion>.RécupèreAgenda

Retrieves a Google calendar and its events according to its title or identifier. This function is using the Google Calendar service.

Example

// Connection
Cnt is gglConnection
...
IF Cnt.Connect =False THEN
Error(ErrorInfo())
END

// Retrieve the calendar named "Work"
Calendar is gglCalendar = Cnt.GetCalendar("Work")
// Browse the events of the calendar
IF ErrorOccurred = False THEN
Evt is gglEvent
FOR EACH Evt OF Calendar
Trace(Evt..Title)
END
END

Syntax

<Result> = <Google connection>.GetCalendar([<Title or identifier> [, <Beginning of events> [, <End of events> [, <String to find>]]]])

<Result>: gglCalendar variable

gglCalendar variable with the characteristics of the retrieved calendar.

<Google connection>: gglConnection variable

Name of gglConnection variable to use. This connection was validated by GglConnect.
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.

<Title or identifier>: Optional Unicode character string

Title or identifier of sought calendar. If this parameter corresponds to an empty string (""), the first available calendar is retrieved (by default).

<Beginning of events>: Optional DateTime

Start date and time of events to retrieve.
If <Beginning of events> and <End of events> are not specified, only the future events are retrieved (events from today's date).
If only <Beginning of events> is specified, all the events found after this date will be retrieved (the limit date defined by Google is 01/01/2031).

<End of events>: Optional DateTime

End date and time of events to retrieve.
If <Beginning of events> and <End of events> are not specified, only the future events are retrieved (events from today's date).
If only <End of events> is specified, all the events found before this date will be retrieved (the limit date defined by Google is 01/01/1970).

<String to find>: Optional character string

Text to find in the calendar events. If this parameter is specified, only the events containing the specified text will be listed. The search is performed on the name and description of the calendar. This search is not case sensitive. This parameter corresponds to an empty string by default.

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.
The calendar was not found.

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

Component : wd240ggl.dll