IMessenger::Signin

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Signs the local client in automatically using the last sign-in name and saved password information. Scriptable.

Important

This method has been deprecated. Use IMessenger::AutoSignin instead.

Syntax

HRESULT Signin(
   [in] long hwndParent,
   [in] BSTR bstrSigninName,
   [in] BSTR bstrPassword
);

Parameters

  • hwndParent
    [in] A LONG. Reserved. All current implementations should set this parameter to 0 or null.
  • bstrSigninName
    [in] Ignored.
  • bstrPassword
    [in] Ignored.

Return Value

Returns one of the following values. In a managed code environment, this value is returned in a COMException event argument as an integer.

  • S_OK
    Success.
  • S_FALSE
    The Sign In dialog box is already open.

  • E_INVALIDARG
    The provided values failed validation tests. The sign-in name or password cannot contain spaces, carriage returns, or linefeed characters. Some services do not accept ANSI values greater than 128. The sign-in name cannot be longer than 129 characters (not including the terminating null character). The password cannot exceed the maximum password length, which is dependent on the version of the Communicator client. These are the input limits enforced on the client. There might be other limits established by the service on initial account creation.

    - or -

    The state of the Messenger object cannot be determined. In scripting, E_INVALIDARG are not returned in the first case because bstrSigninName and bstrPassword are always ignored.

  • E_OUTOFMEMORY
    The string comparison or concatenation failed, or memory could not be allocated for new objects created at sign-in.
  • E_FAIL
    Could not create a Sign In dialog box, or the Messenger object is not responding or has not been created.
  • MSGR_E_ALREADY_LOGGED_ON
    The current user is already signed in.
  • S_FALSE
    (Scripting) The current user is already signed in. S_FALSE cannot usually be captured in scripting error trapping, because the initial error bit is not 1 in this HRESULT.
  • MSGR_E_AUDIO_UI_ACTIVE
    The Audio and Video Tuning Wizard is already open.
  • MSGR_E_option_UI_ACTIVE
    The Options dialog box is already open.
  • MSGR_E_OTHER_UI_ACTIVE
    The Customer Experience Improvement Program (CEIP) dialog box is already open.

Remarks

Use the IMessenger::AutoSignin method instead. The IMessenger::AutoSignin method requires that the client has access to cached credentials (that is, the user has selected Remember My Password in the client UI) or the user has saved credentials in the Windows XP Credentials Manager UI.

Calling this method results in a DMessengerEvents::OnSignin event and a DMessengerEvents::OnMyStatusChange event with MISTATUS_LOCAL_CONNECTING_TO_SERVER, which lasts until the server receives and responds to the protocol-level logon command or the client-side timer window on logon expires. That state lasts until the server of the service receives and responds to the protocol-level logoff command. Otherwise, after 15 seconds without connecting to the server, the client-side timer cancels the logon attempt and generates a DMessengerEvents::OnMyStatusChange event with mMYStatusOE=MISTATUS_OFFLINE and hr=MSGR_E_LOGON_TIMEOUT.

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

See Also

Reference

IMessenger::Signout