RDS client disconnected codes and reasons

This article provides a script to get information about client-side Microsoft® Windows® Remote Desktop Services (RDS)
and Remote Desktop Protocol (RDP) connection issues and describes the most up-to-date disconnect codes and reasons.

Note: Some of the disconnect codes that the script returns are extended codes. If you cannot find the disconnect code in the
following Disconnect reasons table, see the following Extended reasons table.

When you troubleshoot client-side connections, be aware that depending on configurations, such as security level and encryption,
the client might attempt a connection multiple times and disconnect before making the final connection.

Script

The following PowerShell® script queries COM MSTscAx with a decimal disconnect code ID. If the script finds the code, it
returns the description.

Script:    # PowerShell script to return description of rds client disconnect codes in decimal format (not hex)
Param(
    [parameter(Position=0,Mandatory=$true,HelpMessage="Enter the disconnect reason code in decimal from client side rds trace")]
    [string] $disconnectReason,
    [string] $extendedReason = 0
)
$mstsc = New-Object -ComObject MSTscAx.MsTscAx

write-host "description: $($mstsc.GetErrorDescription($disconnectReason,$extendedReason))"

Note: If you get the "an internal error has occurred" message, the script could not find the disconnect code, and the return
description is not valid.

Example

The following event log entry example shows event ID 1026 of an RDP client session-disconnected event. Event code 263 means no error.

Log Name:      Microsoft-Windows-TerminalServices-RDPClient/Operational
Source:        Microsoft-Windows-TerminalServices-ClientActiveXCore
Date:          6/24/2020 7:26:58 PM
Event ID:      1026
Task Category: Connection Sequence
Level:         Information
Keywords:     
User:          client-machine\Arnold
Computer:      client-machine
Description:
RDP ClientActiveX has been disconnected (Reason= 263)
Event Xml:
<Event xmlns="https://schemas.microsoft.com/win/2004/08/events/event Jump ">
  <System>
    <Provider Name="Microsoft-Windows-TerminalServices-ClientActiveXCore" Guid="{28AA95BB-D444-4719-A36F-40462168127E}" />
    <EventID>1026</EventID>
    <Version>0</Version>
    <Level>4</Level>
    <Task>101</Task>
    <Opcode>11</Opcode>
    <Keywords>0x4000000000000000</Keywords>
    <TimeCreated SystemTime="2017-05-03T11:40:58.058887000Z" />
    <EventRecordID>61070</EventRecordID>
    <Correlation ActivityID="{3371E543-77B1-41BA-8835-674829620000}" />
    <Execution ProcessID="14296" ThreadID="15212" />
    <Channel>Microsoft-Windows-TerminalServices-RDPClient/Operational</Channel>
    <Computer>client-machine</Computer>
    <Security UserID="" />
  </System>
  <EventData>
    <Data Name="Name">Disconnect Reason</Data>
    <Data Name="Value">263</Data>
    <Data Name="CustomLevel">Info</Data>
  </EventData>
</Event>

Disconnect reasons

The following table shows the disconnect codes and reasons:

Extended reasons

The following table shows the extended codes and reasons: