Retrieves the sign-in name of the contact that is associated with this IMessengerContact object. Scriptable only locally for getting the property value. This is a read-only property.
Syntax
HRESULT SigninName( [out, retval] BSTR* pbstrSigninName ); |
Parameters
- pbstrSigninName
-
Pointer to a BSTR that uniquely identifies the contact.
Return Value
Returns one of the following values. For managed code applications, these return values are received in the form of a COMException.
- S_OK
-
Success.
- E_FAIL
-
pbstrSigninName returns a null string.
- E_OUTOFMEMORY
-
The string comparison failed.
- RPC_X_NULL_REF_POINTER
-
pbstrSigninName is a null pointer.
- E_NOTIMPL
-
Cannot be accessed through scripting.
Remarks
To get the sign-in name of the local client user rather than a remote user, use the IMessenger::MySigninName method. The Sign-in Address entry control of the Office Communicator UI accepts the same value as the SigninName property of the IMessengerContact interface. This property is read-only.
Example
The following example code is reading the SigninName property on the IMessengerContact object, contact. The code displays the returned Sign-in Name string on the application console window.
Copy Code | |
---|---|
if (contact != null) { try { Console.WriteLine("Contact Signin Name: " + contact.SigninName); } catch (COMException CESG) { Console.WriteLine(CESG.ErrorCode.ToString()); } } |
Requirements
- Client
-
Requires Microsoft DirectX 9.0, C Runtime libraries (msvcm80.dll) on Microsoft Windows© Vista, Microsoft Windows XP Service Pack 1 (SP1) or later, or Microsoft Windows 2000 with Service Pack 4 (SP4). Any Communicator-imposed restrictions apply. .
- Server
-
Requires Microsoft Office Communications Server 2007, AV MCU (for Media Support), Media Relay (for NAT/Firewall traversal) on Microsoft Office Communications Server 2007.
- Product
-
Microsoft Office Communicator 2007 Automation API
- IDL file
-
Msgrua.idl