CalendarSubscribe()

Subscribe to an internet calendar.

Token ID

AFTKN_CALENDAR_SUBSCRIBE or 936

Syntax

VOID CalendarSubscribe(
     WORDSTRING CalendarURL;
     WORDSTRING FolderName;
     [WORDSTRING] Description;
     [DWORD] RefreshFrequency;
     [WORDSTRING] UserName;
     [WORDSTRING] Password)

Parameters

CalendarURL As WIDESTRING

The URL of the internet calendar to subscribe to. For example:

webcal://icalx.com/public/domain/example.ics
FolderName As WIDESTRING

The full path of the folder to create in GroupWise to display the subscribed calendar.

Description As WIDESTRING

(Optional) A description of the internet calendar.

Password As WORDSTRING

(Optional) Password to specify by way of HTTP Basic Auth as part of the HTTP GET of the internet calendar. Note that this is only required for user name/password protected calendar.

RefreshFrequency As DWORD

(Optional) Frequency of refresh in seconds. For example:

  • Daily = 24 * 60 * 60
  • Hourly = 60 * 60
  • 15 Minutes = 15 * 60
UserName As WORDSTRING

(Optional) User name to specify by way of HTTP Basic Auth as part of the HTTP GET of the internet calendar. Note that this is only required for user name/password protected calendars.