IMsTscAxEvents::OnAutoReconnecting method

Article
03/09/2021

Called when a client is in the process of automatically reconnecting a session with a Remote Desktop Session Host (RD Session Host) server.

Syntax

void OnAutoReconnecting(
  [in]  LONG                       disconnectReason,
  [in]  LONG                       attemptCount,
  [out] AutoReconnectContinueState *pArcContinueStatus
);

Parameters

disconnectReason [in]

Code describing the reason for the last session disconnection.

attemptCount [in]

Number of attempts that have been made in the current automatic reconnection process. This count increases by one for each attempt made.

pArcContinueStatus [out]

Pointer to a returned code specifying the state of the automatic reconnection process. This code can be reset to change the state of the current automatic reconnection process.

For more information about resetting this code, refer to the Remarks section.

autoReconnectContinueAutomatic (0)

The reconnection process is occurring automatically. This is the default value.

autoReconnectContinueStop (1)

The reconnection process has been stopped.

autoReconnectContinueManual (2)

The reconnection process is occurring manually.

Return value

This method does not return a value.

Remarks

Implement this method in your event sink to receive notification that the control is reestablishing a connection with an RD Session Host server.

When the state of the automatic reconnection process is changed by setting the value of the pArcContinueStatus parameter to autoReconnectContinueAutomatic, this method functions in a purely advisory mode. Containers can listen to this event for notifications that the automatic reconnection process is proceeding. The control will automatically keep trying to re-establish a connection based on its own internal timing and attempt counts. This method is called during each automatic reconnection attempt in order to notify the container.

When the state of the automatic reconnection process is changed by setting the value of the pArcContinueStatus parameter to autoReconnectContinueStop, the current automatic reconnection attempt will be terminated, a disconnect notification will be sent to the container, and no further automatic reconnect notifications will be issued.

Note

Use the EnableAutoReconnect property to enable or disable automatic reconnection.

When the state of the automatic reconnection process is changed by setting the value of the pArcContinueStatus parameter to autoReconnectContinueManual, the container will manually control the automatic reconnection process by calling Connect to trigger a connection attempt or Disconnect to cancel the automatic reconnection process. Once set to this value, the control will stop making automatic reconnection attempts and it becomes the policy of the container to make Connect calls to trigger automatic reconnection attempts. This is done when the container provides customized UI behavior for automatic reconnection, such as restarting a dropped RAS or VPN connection before the automatic reconnection process.

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

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Type library	MsTscAx.dll
DLL	MsTscAx.dll