IMsgrSession::State Property

  • Article

Deprecated. Retrieves a value that indicates the current state of the session.

Syntax

HRESULT IMsgrSession::get_State(SESSION_STATE *pState);

Parameters

  • pState
    Pointer to a value from the SESSION_STATE enumeration that indicates the current state of the session.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

Error Code Meaning
E_INVALIDARG The value passed into the property was not valid.
E_OUTOFMEMORY The session identifier is too long.

Important  IMsgrSession::State is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

SESSION_STATE, Messenger Session Invite and Messenger Private APIs, Messenger Lock and Key API