IMsRdpClient::ExtendedDisconnectReason property

Contains extended information about the control's reason for disconnection.

This property is read-only.

Syntax


HRESULT get_ExtendedDisconnectReason(
  [out]  ExtendedDisconnectReasonCode *pExtendedDisconnectReason
);

Property value

Pointer to the retrieved property value, an extended reason for disconnection of the client. This parameter can be one of the following values.

ValueMeaning
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 time-out 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 denied the connection.

exDiscReasonServerDeniedConnectionFips
0x0008

The server denied the connection for security reasons.

exDiscReasonLicenseInternal
0x0100

Internal licensing error.

exDiscReasonLicenseNoLicenseServer
0x0101

No license server was available.

exDiscReasonLicenseNoLicense
0x0102

No valid software license was available.

exDiscReasonLicenseErrClientMsg
0x0103

The remote computer received a licensing message that was not valid.

exDiscReasonLicenseHwidDoesntMatchLicense
0x0104

The hardware ID does not match the one designated 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 through exDiscReasonProtocolRangeEnd
0x1000 through 0x7FFF

Values in this range represent internal protocol errors. Check the server event log for additional details.

 

Error codes

If the method succeeds, S_OK is returned. Any other HRESULT value indicates that the call failed.

Remarks

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

For more information about Remote Desktop Web Connection, see Requirements for Remote Desktop Web Connection.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Type library

Mstscax.dll

DLL

Mstscax.dll

IID

IID_IMsRdpClient is defined as 92b4a539-7115-4b7c-a5a9-e5d9efc2780a

See also

IMsRdpClient2
IMsRdpClient3
IMsRdpClient4
IMsRdpClient5
IMsRdpClient6
IMsRdpClient7
IMsRdpClient8
IMsRdpClient
IMsTscAxEvents::OnDisconnected

 

 

Show:
© 2014 Microsoft