IMessengerWindow::Property property

Article
05/31/2018

[Property is no longer available for use as of Windows Vista. See Windows Messenger for more information.]

Sets or retrieves the conversation window properties.

This property is read/write.

Syntax

HRESULT put_Property(
  [in]          MWINDOWPROPERTY ePropType,
  [in]          VARIANT         vPropVal
);

HRESULT get_Property(
  [in]          MWINDOWPROPERTY ePropType,
  [out, retval] VARIANT         *pvPropVal
);

Property value

A pointer to a VARIANT that contains the property value. (Variant type differs depending on the property being set or retrieved.)

Error codes

Returns one of the following values.

Name	Meaning
S_OK	The property value has been set successfully.
RPC_X_NULL_REF_POINTER	pvPropVal is a NULL pointer.
E_INVALIDARG	ePropType is out of range.
S_FALSE	The method was used twice with the same values.
E_NOTIMPL	Attempted to use the method on the Phone window or main application window.

Remarks

The following table lists error codes returned by this method.

Error Code	Meaning
0x80004001	Attempted to use the method on the Phone window or main application window.
0x80070057	ePropType is out of range.

Note

The get_Property property is available for scripting languages; put_Property is not.

Examples

The following Visual Basic example shows the use of this method.

Public WithEvents MsgrUIA As MessengerAPI.Messenger 
Public MsgrWindow As MessengerAPI.IMessengerWindow 
Public MsgrContact As MessengerAPI.IMessengerContact

Private Sub GetWindowProperty_Click() 
    On Error Resume Next 
    FormContactName.Show vbModal 'Open dialog for user input 
    Dim PropSB, PropTB As Variant 
    If bDialogCancel = False Then 
        If bContactasObject = True Then 
            Set MsgrContact = Nothing 
            Set MsgrContact = MsgrUIA.GetContact(strContactName, strServiceID) 
            MsgrWindow = MsgrUIA.InstantMessage(MsgrContact) 
            ' Get the SideBar Status 
            PropSB = MsgrWindow.Property(MWINDOWPROP_VIEW_SIDEBAR) 
            ' Get the ToolBar Status 
            PropTB = MsgrWindow.Property(MWINDOWPROP_VIEW_TOOLBAR) 
        End If 
    End If 
    bContactasObject = False 
    ErrorTrap ("IMessengerWindow.Property") 'Error handling routine 
End Sub

Requirements


End of client support	Windows XP
End of server support	Windows Server 2003
Header	Msgrua.h
IDL	Msgrua.idl
DLL	Msgsc.dll