Recipient.FreeBusy(DateTime, Int32, Object) Method

Definition

Returns free/busy information for the recipient.

public string FreeBusy (DateTime Start, int MinPerChar, object CompleteFormat);
Public Function FreeBusy (Start As DateTime, MinPerChar As Integer, Optional CompleteFormat As Object) As String

Parameters

Start
DateTime

The start date for the returned period of free/busy information.

MinPerChar
Int32

The number of minutes per character represented in the returned free/busy string.

CompleteFormat
Object

True if the returned string should contain not only free/busy information, but also values for each character according to the OlBusyStatus constants.

Returns

A String (string in C#) value that represents the free/busy information.

Remarks

The default is to return a string representing one month of free/busy information compatible with the Microsoft Schedule+ Automation format (that is, the string contains one character for each MinPerChar minute, up to one month of information from the specified Start date).

If the optional argument CompleteFormat is omitted or False, then "free" is indicated by the character 0 and all other states by the character 1.

If CompleteFormat is True, then the same length string is returned as defined above, but the characters now correspond to the OlBusyStatus constants.

Applies to