PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Special cases
  • Required permissions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Lists the appointments found on the mobile device (Android/iOS) and corresponding to the specified criteria.
Versions 21 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 21
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Example
// Lists all the appointments for the day
StartDate is Date = DateSys()
EndDate is Date = DateSys()
EndDate..Day += 1
arrAPT is array of Appointment = AppointmentList(Null, StartDate, EndDate)

//--------------------------------------------------------------

// Lists all the future appointments from next week
StartDate is Date = DateSys()
StartDate..Day += 7
arrAPT is array of Appointment = AppointmentList(Null, StartDate)

//--------------------------------------------------------------

// Lists the future appointments found in <MyCalendar>
// that contain "car" in the title or in the description of the appointment
arrAPT is array of Appointment = AppointmentList(MyCalendar, "", "", ...
aptTitle + aptContent, "car")

//--------------------------------------------------------------

// Finds an appointment corresponding to a given identifier
arrAPT is array of Appointment = AppointmentList(Null, "", "", aptIdentifier, nID)
Syntax
<Result> = AppointmentList([<Calendar> [, <Start> [, <End> [, <Filter> [, <Sought Value>]]]]])
<Result>: Array of Appointment variables
Array of Appointment variables initialized with the list of appointments corresponding to the specified criteria.
If an error occurred, the array is empty and the ErrorOccurred variable is set to True. To find out the error details, use ErrorInfo.
<Calendar>: Optional Calendar variable
  • Name of Calendar variable describing the calendar (organizer) containing the appointments to list.
  • NULL to list the appointments found in all available calendars.
Caution: A calendar must exist if it is specified.
<Start>: Optional DateTime
Local start date and time for the appointments to list.
  • If <Start> and <End> are not specified, only the future appointments will be listed (from today's date and time).
  • If only <Start> is specified, all the appointments found after this date will be retrieved (the limit date is set to 01/01/2031).
  • If <Start> must not be specified and if at least one of the following parameters must be specified, use an empty string ("").
Note: If only the date is specified (without specifying the hours, minutes and seconds), the events will be taken into account from the specified date at 0 hour 0 minute 0 second.
<End>: Optional DateTime
Local end date and time for the appointments to list.
  • If <Start> and <End> are not specified, only the future appointments will be listed (from today's date and time).
  • If only <End> is specified, all the appointments found before this date will be listed (the limit date defined by Google is 01/01/1970).
  • If <End> must not be specified and if at least one of the following parameters must be specified, use an empty string ("").
Note: If only the date is specified (without specifying the hours, minutes and seconds), the events will be taken into account until the specified date at 0 hour 0 minute 0 second (therefore, the events for the day will not be taken into account).
<Filter>: Optional Integer constant (or combination of constants)
Properties on which the list of appointments must be filtered:
aptContentFilters on the appointment description (contains search).
aptIdentifierFilters on the appointment identifiers (exact-match search).
aptLocationFilters on the appointment location (contains search).
aptTitleFilters on the appointment title (contains search).

Note: If several filters are specified (combination of constants), an appointment will be listed if at least one of the filtered properties corresponds to the sought value.
<Sought Value>: Optional character string
Value sought in the filtered properties of appointment. This search is not case sensitive.
Remarks

Special cases

  • The search for appointments is always performed by taking the current time zone into account. On the contrary, ..StartDébut and ..EndFin of Appointment type are always expressed in the time zone associated with the appointment.
  • Android AppointmentList can be used in the emulator but not in the simulator.
  • Android AppointmentList is available for the devices running an Android version greater than or equal to version 4.0 (api level 14). A fatal error occurs if the function is used with an earlier system version.
    Reminder: To find out the version of Android system on which the application is run, use SysAndroidVersion.
Android

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.
Components
Android wd230android.jar
Minimum required version
  • Version 18
Comments
Click [Add] to post a comment