IMsgrSession::ContextData property

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

Retrieves a value that indicates the application-specific context data.

This property is read-only.

Syntax

HRESULT get_ContextData(
  [out, retval] BSTR *pbstrData
);

Property value

Pointer to a BSTR that specifies the application-specific context data.

Remarks

The following table lists the error codes returned by this property.

Error Code Meaning
E_INVALIDARG The value passed to the property was not valid.
E_OUTOFMEMORY The context data was too long.
S_FALSE The context data was not retrieved successfully for unspecified reasons.

The following table lists the error codes returned by this property.

Error Code Meaning
0x8007000E The context data was too long.
0x80070057 One of the possible values is not valid.

Requirements

Minimum supported client
Windows XP [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
End of client support
Windows XP
End of server support
Windows Server 2003
Product
Messenger 4.0
Header
Msgrpriv.h
IDL
Msgrpriv.idl
DLL
Msgsc.dll

See also

IMsgrSession

Messenger Session Invite and Messenger Private APIs

Messenger Lock and Key API