IMessenger::MyStatus Property

  • Article

Deprecated. Deprecated in Microsoft Windows Messenger 5.0. Service status.

Syntax

HRESULT IMessenger::get_MyStatus(MISTATUS *pmiStatus);

Parameters

  • pmiStatus
    Pointer to a variable of type MISTATUS that receives the current status for the local client.

Return Value

Returns one of the following values.

S_OK Success.
RPC_X_NULL_REF_POINTER pmiStatus is a NULL pointer.

Remarks

Important   The IMessenger::MyStatus property is available for use in Windows Messenger 5.0. It may be unavailable in subsequent versions. Use IMessengerService::MyStatus instead. To return a list of MessengerService objects, use the IMessenger::Services property.

If the local client is offline, this property returns without attempting to connect. Otherwise, this property will always query the server for the client's local state; it will not use locally stored information.

When multiple clients are registered, get_MyStatus returns the status of the primary client at the time of the call. put_MyStatus sets the status for all the services that each registered client is signed into to the status passed in pmiStatus. The HRESULT returned is from the primary client.

Important  IMessenger::MyStatus is no longer available in Windows Vista. See Windows Messenger for more information.

Note  The get_MyStatus property is available for scripting languages; put_MyStatus is not.

See Also

IMessengerService::MyStatus