PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
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
SchedulerListAppointment (Function)
In French: PlanningListeRendezVous
Returns:
  • the list of appointments found between two dates in a Scheduler control,
  • all the appointments found in a Scheduler control,
  • a specific appointment (selected or hovered).
Versions 17 and later
WINDEVReports and Queries This function can now be used to handle the Scheduler controls found in a report.
New in version 17
WINDEVReports and Queries This function can now be used to handle the Scheduler controls found in a report.
WINDEVReports and Queries This function can now be used to handle the Scheduler controls found in a report.
Versions 21 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
Android This function is now available for the Android applications.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App In Universal Windows 10 App mode, this function can only be used to handle the Scheduler controls found in a report.
New in version 21
iPhone/iPad This function is now available for the iPhone/iPad applications.
Android This function is now available for the Android applications.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App In Universal Windows 10 App mode, this function can only be used to handle the Scheduler controls found in a report.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Android This function is now available for the Android applications.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App In Universal Windows 10 App mode, this function can only be used to handle the Scheduler controls found in a report.
Example
// Lists all schedule appointments
arrApt is array of Appointment
MyResource = "Vince"
arrApt = SchedulerListAppointment(SCH_Schedule)

// Adds the appointments into a table
FOR EACH gMyAppointment OF arrApt
TableAddLine(TABLE_Table1, MyResource, ...
gMyAppointment..StartDate, gMyAppointment..EndDate, gMyAppointment..Title)
END
// Lists the appointments from today's date
arrApt is array of Appointment
arrApt = SchedulerListAppointment(SCH_Schedule, MyResource, DateSys())
Syntax

Retrieving the list of appointments found between two dates Hide the details

<Result> = SchedulerListAppointment(<Scheduler Control> [, <Resource> [, <Start Date> [, <End Date>]]])
<Result>: Array of Appointment variables
Array containing the Appointment variables.
If an appointment corresponding to the specified criteria exists, this array will contain a single element.
If no appointment corresponds to the specified criteria, this array will contain 0 appointment.
<Scheduler Control>: Control name
Name of Scheduler control to use. This control can correspond to:
  • the Scheduler control of a window,
  • the Scheduler control of a page,
  • Versions 17 and later
    the Scheduler control of a report.
    New in version 17
    the Scheduler control of a report.
    the Scheduler control of a report.
<Resource>: Optional character string (with quotes)
Name of resource to which the appointments will be associated. If this parameter is not specified (or if it corresponds to an empty string), all appointments of all resources will be returned.
Note: If the schedule resources have been created with SchedulerAddResource by using gLink, this parameter must correspond to the value specified in gLink for this resource.
<Start Date>: Optional DateTime variable
Start date for selecting the appointments.
If this parameter is not specified, all the appointments found in the Scheduler control will be returned.
<End Date>: Optional DateTime variable
End date for selecting the appointments.
If this parameter is not specified, all appointments found from <Start Date> will be returned.

Retrieving the information about a specific appointment Hide the details

<Result> = SchedulerListAppointment(<Scheduler Control> , <Type of Appointment>)
<Result>: Array of Appointment variables
Name of array containing the Appointment variables.
If an appointment corresponding to the specified criteria exists, this array will contain a single element.
If no appointment corresponds to the specified criteria, this array will contain 0 appointment.
<Scheduler Control>: Control name
Name of Scheduler control to use. This control can correspond to:
  • the Scheduler control of a window,
  • the Scheduler control of a page,
  • Versions 17 and later
    the Scheduler control of a report.
    New in version 17
    the Scheduler control of a report.
    the Scheduler control of a report.
<Type of Appointment>: Integer constant
Type of appointment sought:
schAptSelectedAppointment currently selected in the Scheduler control. If no appointment is selected, <Result> will correspond to an array of 0 element.
schAptHoveredAppointment hovered by the mouse cursor in the Scheduler control. If no appointment is hovered, <Result> will correspond to an array of 0 element.
Android This constant is not available.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230mdl.dll
Linux wd230mdl.so
Android wd230android.jar
Minimum required version
  • Version 16
This page is also available for…
Comments
Click [Add] to post a comment