AppointmentAdd (Function)

Adds an appointment:

into the calendar of a Lotus Notes or Outlook messaging. The Appointment structure is used to define the data of this contact.
Reminder: This function cannot be used to add an appointment into the calendar of an Outlook Express messaging.
Versions 18 and later
into the calendar found on an Android device.
New in version 18
into the calendar found on an Android device.
into the calendar found on an Android device.
Versions 21 and later
into the calendar found on an iOS device.
New in version 21
into the calendar found on an iOS device.
into the calendar found on an iOS device.

Versions 18 and later

This function is now available in Android Widget mode.

New in version 18

This function is now available in Android Widget mode.

Versions 21 and later

This function is now available for the iPhone/iPad applications.

New in version 21

This function is now available for the iPhone/iPad applications.

Example

See additional examples

// Start a Lotus Notes session
SessionID is int
SessionID = EmailStartNotesSession("Password", "MarsServer", ...
"email/julia.nsf", "C:\Lotus Notes\julia.id")
// Initialize the variables of the Appointment structure
AppointmentReset()
// Fill the variables for the new appointment
mAppointment.Subject = "Sales meeting"
mAppointment.StartDate ="20070125100000"
mAppointment.Location = "Room 3B"
mAppointment.NbParticipant = 3
mAppointment.Participant[1] = "Robert"
mAppointment.Participant[2] = "Lucas"
mAppointment.Participant[3] = "Stephen"
// Add the appointment
IF AppointmentAdd(SessionID) = True THEN
Info("Appointment added")
ELSE
Error("Error during the addition", ErrorInfo())
END

Versions 18 and later

gAPT is Appointment
gCal is Calendar
arrCalendar is array of Calendar
// Retrieves the list of calendars
arrCalendar = AppointmentListCalendar()
gCal = arrCalendar[1]

// Add a new appointment into the first calendar
gAPT..Title = EDT_Title
gAPT..StartDate = EDT_StartDate + EDT_StartTime
gAPT..EndDate = EDT_EndDate + EDT_EndTime
gAPT..Location = EDT_Location
gAPT..Content = EDT_Desc
IF EDT_TimeZone <> "" THEN
gAPT..TimeZone = EDT_TimeZone
END
gAPT..Author = EDT_Author
gAPT..Guest = EDT_Guests
gAPT..WholeDay = CBOX_WholeDay[1]

IF AppointmentAdd(gCal, gAPT) THEN
ToastDisplay("APT added")
ELSE
Error(ErrorInfo())
END

New in version 18

gAPT is Appointment
gCal is Calendar
arrCalendar is array of Calendar
// Retrieves the list of calendars
arrCalendar = AppointmentListCalendar()
gCal = arrCalendar[1]

// Add a new appointment into the first calendar
gAPT..Title = EDT_Title
gAPT..StartDate = EDT_StartDate + EDT_StartTime
gAPT..EndDate = EDT_EndDate + EDT_EndTime
gAPT..Location = EDT_Location
gAPT..Content = EDT_Desc
IF EDT_TimeZone <> "" THEN
gAPT..TimeZone = EDT_TimeZone
END
gAPT..Author = EDT_Author
gAPT..Guest = EDT_Guests
gAPT..WholeDay = CBOX_WholeDay[1]

IF AppointmentAdd(gCal, gAPT) THEN
ToastDisplay("APT added")
ELSE
Error(ErrorInfo())
END

Syntax

Adding an appointment into the calendar of a Lotus Notes ou Outlook messaging Hide the details

<Result> = AppointmentAdd(<Session identifier>)

<Result>: Boolean

True if the addition was performed,
False otherwise. To find out the error details, use ErrorInfo.

<Session identifier>: Integer

Identifier of session to use. This identifier is returned by one of the following functions: EmailStartNotesSession, EmailStartOutlookSession, NotesOpenDatabase or OutlookStartSession.

Versions 18 and later

This syntax is available from version 180046.

Adding an appointment into a calendar found on an Android device Hide the details

<Result> = AppointmentAdd(<Calendar> , <Appointment>)

<Result>: Boolean

True if the addition was performed,
False otherwise. To find out the error details, use ErrorInfo.

<Calendar>: Calendar variable

Name of the Calendar variable corresponding to the Android calendar into which the appointment will be added.

<Appointment>: Appointment variable

Name of the Appointment variable corresponding to the appointment that will be added into the specified calendar on the Android device.

New in version 18

This syntax is available from version 180046.

Adding an appointment into a calendar found on an Android device Hide the details

<Result> = AppointmentAdd(<Calendar> , <Appointment>)

<Result>: Boolean

True if the addition was performed,
False otherwise. To find out the error details, use ErrorInfo.

<Calendar>: Calendar variable

Name of the Calendar variable corresponding to the Android calendar into which the appointment will be added.

<Appointment>: Appointment variable

Name of the Appointment variable corresponding to the appointment that will be added into the specified calendar on the Android device.

This syntax is available from version 180046.

Adding an appointment into a calendar found on an Android device Hide the details

<Result> = AppointmentAdd(<Calendar> , <Appointment>)

<Result>: Boolean

True if the addition was performed,
False otherwise. To find out the error details, use ErrorInfo.

<Calendar>: Calendar variable

Name of the Calendar variable corresponding to the Android calendar into which the appointment will be added.

<Appointment>: Appointment variable

Name of the Appointment variable corresponding to the appointment that will be added into the specified calendar on the Android device.

Adding an appointment into a calendar found on an Android/iOS device Hide the details

<Result> = AppointmentAdd(<Calendar> , <Appointment>)

<Result>: Boolean

True if the addition was performed,
False otherwise. To find out the error details, use ErrorInfo.

<Calendar>: Calendar variable

Name of the Calendar variable corresponding to the Android/iOS calendar into which the appointment will be added.

<Appointment>: Appointment variable

Name of the Appointment variable corresponding to the appointment that will be added into the specified calendar on the Android/iOS device.

Remarks

Calendar of a Lotus Notes or Outlook messaging

When creating an appointment with reminder in Outlook, the reminder is immediately displayed regardless of the appointment date.
The added appointments are "meeting" appointments (instead of "appointment" appointments). To modify the type of appointment, all you have to do is modify the "AppointmentType" control of the created appointment (with NotesModifyItem for example).
The different possible values for the types are as follows:
- "0": appointment
- "1": anniversary
- "2": event
- "3": meeting
- "4": reminder
Example:

NotesModifyItem(ID, "AppointmentType", "0")
Versions 18 and later
In Outlook, the management mode of contacts/participants can be specified when starting the session (EmailStartOutlookSession or OutlookStartSession).
New in version 18
In Outlook, the management mode of contacts/participants can be specified when starting the session (EmailStartOutlookSession or OutlookStartSession).
In Outlook, the management mode of contacts/participants can be specified when starting the session (EmailStartOutlookSession or OutlookStartSession).

Versions 18 and later

Android calendar

AppointmentAdd can be used in the emulator but not in the simulator.
AppointmentAdd 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.

New in version 18

Android calendar

AppointmentAdd can be used in the emulator but not in the simulator.
AppointmentAdd 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 calendar

AppointmentAdd can be used in the emulator but not in the simulator.
AppointmentAdd 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.

Component : wd240com.dll