IMsRdpClient::get_ExtendedDisconnectReason

  • Article

This method retrieves extended information about why the Remote Desktop ActiveX control disconnected. This interface was added for RDP clients (version 5.1 and later).

HRESULT get_ExtendedDisconnectReason(
  ExtendedDisconnectReasonCode* pExtendedDisconnectReason
);

Parameters

  • pExtendedDisconnectReason
    [out, retval] Pointer to a code specifying the reason why the client disconnected. The following table shows possible values for this parameter.
    Value Description
    exDiscReasonNoInfo
    (0x0000)    		 No additional information is available.
    exDiscReasonAPIInitiatedDisconnect
    (0x0001)    		 An application initiated the disconnection.
    exDiscReasonAPIInitiatedLogoff
    (0x0002)    		 An application logged off the client.
    exDiscReasonServerIdleTimeout
    (0x0003)    		 The server has disconnected the client because the client has been idle for a period of time longer than the designated timeout period.
    exDiscReasonServerLogonTimeout
    (0x0004)    		 The server has disconnected the client because the client has exceeded the period designated for connection.
    exDiscReasonReplacedByOtherConnection
    (0x0005)    		 The client's connection was replaced by another connection.
    exDiscReasonOutOfMemory
    (0x0006)    		 No memory is available.
    exDiscReasonServerDeniedConnection
    (0x0007)    		 The server refused the connection.
    exDiscReasonLicenseInternal
    (0x0100)    		 Internal licensing error.
    exDiscReasonLicenseNoLicenseServer
    (0x0101)    		 No licensing server was available.
    exDiscReasonLicenseNoLicense
    (0x0102)    		 No valid software license was available.
    exDiscReasonLicenseErrClientMsg
    (0x0103)    		 The remote computer received an invalid licensing message.
    exDiscReasonLicenseHwidDoesntMatchLicense
    (0x0104)    		 The hardware ID does not match the ID on the software license.
    exDiscReasonLicenseErrClientLicense
    (0x0105)    		 Client license error.
    exDiscReasonLicenseCantFinishProtocol
    (0x0106)    		 Network problems occurred during the licensing protocol.
    exDiscReasonLicenseClientEndedProtocol
    (0x0107)    		 The client ended the licensing protocol prematurely.
    exDiscReasonLicenseErrClientEncryption
    (0x0108)    		 A licensing message was encrypted incorrectly.
    exDiscReasonLicenseCantUpgradeLicense
    (0x0109)    		 The local computer's client access license could not be upgraded or renewed.
    exDiscReasonLicenseNoRemoteConnections
    (0x010A)    		 The remote computer is not licensed to accept remote connections.
    exDiscReasonProtocolRangeStart
    (0x1000) through
    exDiscReasonProtocolRangeEnd
    (0x7FFF)    		 Values in this range represent internal protocol errors. Check the server event log for additional details.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method returns a nonzero error code.

Remarks

This method is typically called in the IMsTscAxEvents::OnDisconnected event handler to retrieve additional information about the disconnection event.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Discodlg.h. Mstsax.idl.
Link Library: Mstsax.lib.

See Also

IMsRdpClient

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.