Share via


Recipient.FreeBusy Method

Returns free/busy information for the recipient.

Namespace:  Microsoft.Office.Interop.Outlook
Assembly:  Microsoft.Office.Interop.Outlook (in Microsoft.Office.Interop.Outlook.dll)

Syntax

'Declaration
Function FreeBusy ( _
    Start As DateTime, _
    MinPerChar As Integer, _
    CompleteFormat As Object _
) As String
'Usage
Dim instance As Recipient
Dim Start As DateTime
Dim MinPerChar As Integer
Dim CompleteFormat As Object
Dim returnValue As String

returnValue = instance.FreeBusy(Start, _
    MinPerChar, CompleteFormat)
string FreeBusy(
    DateTime Start,
    int MinPerChar,
    Object CompleteFormat
)

Parameters

  • Start
    Type: System.DateTime
    The start date for the returned period of free/busy information.
  • MinPerChar
    Type: System.Int32
    The number of minutes per character represented in the returned free/busy string.
  • CompleteFormat
    Type: System.Object
    True if the returned string should contain not only free/busy information, but also values for each character according to the OlBusyStatus constants.

Return Value

Type: System.String
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.

See Also

Reference

Recipient Interface

Recipient Members

Microsoft.Office.Interop.Outlook Namespace