IMessenger::MySigninName Property

  • Article

Deprecated. Deprecated in Microsoft Windows Messenger 5.0. Sign-in name.

Syntax

HRESULT IMessenger::get_MySigninName(BSTR *pbstrName);

Parameters

  • pbstrName
    Return value. A pointer to a BSTR that contains the current user's sign-in name.

Return Value

Returns one of the following values.

S_OK Success.
RPC_X_NULL_REF_POINTER pbstrName is a NULL pointer.
E_OUTOFMEMORY String comparison failed.
E_FAIL Local client is offline.
MSGR_E_NOT_LOGGED_ON Client is offline.

Remarks

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

This property fails if the local client is offline. This property does not recheck the user store for the current user's sign-in name. The value returned will be the value entered on the client upon the initial sign-in for this session, which is cleared when the current user signs out.

The Microsoft .NET Messenger Service client can potentially be signed in to multiple services. The client must be signed in to the primary service; if multiple services are enabled, this property returns the sign-in name for the primary service only. For the .NET Messenger Service, the sign-in name is a Windows Live ID sign-in name and thus will follow validation rules for e-mail addresses and correspond to a Windows Live ID identity. For other services, the sign-in name may follow different validation rules.

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

Note  This property is not available for scripting languages.

See Also

IMessengerService::MySigninName