AddressEntry.GetFreeBusy(DateTime, Int32, Object) AddressEntry.GetFreeBusy(DateTime, Int32, Object) Method

Definition

Returns a String (string in C#) value that represents the availability of the individual user for a period of 30 days from the start date, beginning at midnight of the date specified.

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

Parameters

Start
DateTime DateTime

Specifies the date.

MinPerChar
Int32 Int32

Specifies the length of each time slot in minutes. The default value is 30.

CompleteFormat
Object Object

Specifies a Boolean value (bool in C#) that represents the level of information returned for each time slot. The default value is False.

Returns

A String (string in C#) value that represents the availability of the user for the specified period. The string value contains one character for each time slot within the specified period.

Remarks

Note: If an address entry represents a distribution list, the status of its individual members cannot be returned to you with the GetFreeBusy method. A meeting request should be sent only to single messaging users. You can determine if a messaging user is a distribution list by determining if its DisplayType property is olDistList or olPrivateDistList.

The contents of the string returned by this method are determined by the CompleteFormat parameter.

If CompleteFormat is set to False, the default value, the string returned by this method contains one of the following characters for each time slot:

CharacterDescription
0The time slot represents a free period.
1The time slot represents a tentative, out of office (OOF), or busy period.

If CompleteFormat is set to True, the string returned by this method contains one of the following characters for each time slot:

CharacterDescription
0The time slot represents a free period.
1The time slot represents a tentative period.
2The time slot represents a busy period.
3The time slot represents an out of office (OOF) period.

Applies to