IMessenger::MySigninName property

[IMessenger::MySigninName is no longer available for use as of Windows Vista. For more information, see Windows Messenger.]

Sign-in name. Use MySigninName instead. To return a list of MessengerService objects, use the Services property.

This property is read-only.

Syntax

HRESULT get_MySigninName(
  [out, retval] BSTR *pbstrName
);

Property value

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

Error codes

Returns one of the following values.

Name Meaning
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

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 Microsoft .NET Messenger Service, the sign-in name is a Windows Live ID sign-in name and thus will follow validation rules for email addresses and correspond to a Windows Live ID identity. For other services, the sign-in name may follow different validation rules.

Note

This property is not available for scripting languages.

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
Header
Msgrua.h
IDL
Msgrua.idl
DLL
Msgsc.dll

See also

IMessenger

MySigninName