AppointmentListCalendar (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Special cases
Required permissions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

AppointmentListCalendar (Function)

In french: RendezVousListeCalendrier

Lists the calendars available on the mobile device (Android/iOS).

Versions 21 and later

This function is now available for iPhone/iPad applications.

New in version 21

This function is now available for iPhone/iPad applications.

Example

See additional examples

// Fill a List Box control with the calendars available on the device
arrCalendar is array of Calendar
arrCalendar = AppointmentListCalendar()
FOR EACH Calendar OF arrCalendar
ListAdd(LIST_List1, Calendar.Name)
END

Syntax

Listing the available calendars Hide the details

<Result> = AppointmentListCalendar()

<Result>: Array of Calendar variables

Array of Calendar variables initialized with the list of available calendars.
If an error occurred, the array is empty and the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo.

This syntax is available from version 180056.

Listing the calendars that correspond to the specified filters Hide the details

<Result> = AppointmentListCalendar(<Filter> , <Sought value>)

<Result>: Array of Calendar variables

Array of Calendar variables initialized with the list of available calendars.
If an error occurred, the array is empty and the ErrorOccurred variable is set to True. To get more details on the error, use ErrorInfo.

<Filter>: Integer constant

Property on which the list of calendars must be filtered:
aptAccountName Filters on the name of the account to which the calendar belongs. A "Contains" search is performed.
aptAccountType Filters on the type of the account to which the calendar belongs. A "Contains" search is performed.
aptIdentifier Filters on the identifiers of calendars. An exact-match search is performed.
aptName Filters on the name of the calendar. A "Contains" search is performed.

<Sought value>: Character string

Value sought in the filtered properties of calendar. This search is not case sensitive.

Remarks

Special cases

AppointmentListCalendar can be used in the emulator but not in the simulator.
To list the appointments found in a calendar, use AppointmentList.

AppointmentListCalendar is only available for devices running Android 4.0 or later (API level 14). A fatal error occurs if the function is used with an earlier system version.
Reminder: To determine the version of Android the application is running on, use SysAndroidVersion.

Required permissions

The call to this function modifies the permissions required by the application.
Required permission: READ_CALENDAR
This permission allows the application to read the calendar data of the user.

Component: wd270android.aar