CalendarDescription Property

The description of the calendar.

Syntax

 gcalendar.getCalendarDescription([callback])
 gcalendar.setCalendarDescription( calendarDescription, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getCalendarDescription([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setCalendarDescription([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property holds the description of the calendar. It is populated after CalendarIndex is set. It may optionally be set before calling CreateCalendar.

This property is not available at design time.

Data Type

String