IMsRdpClient5::GetErrorDescription method

Retrieves the error description for the session disconnect events.

Syntax

HRESULT GetErrorDescription(
  [in]  UINT disconnectReason,
  [in]  UINT extendedDisconnectReason,
  [out] BSTR *pBstrErrorMsg
);

Parameters

disconnectReason [in]

The disconnect reason.

extendedDisconnectReason [in]

Provides detailed information about why a disconnect was initiated.

pBstrErrorMsg [out]

A pointer to a BSTR variable that receives the error message text.

Return value

This method does not return a value.

Requirements

Requirement Value
Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Type library
MsTscAx.dll
DLL
MsTscAx.dll
IID
IID_IMsRdpClient5 is defined as 4eb5335b-6429-477d-b922-e06a28ecd8bf

See also

IMsRdpClient5

IMsRdpClient6

IMsRdpClient7

IMsRdpClient8

IMsRdpClient9

IMsRdpClient10