Edit

Share via

IWRdsProtocolShadowConnection::Start method (wtsprotocol.h)

  • Article

Notifies the protocol that shadowing has started.

Syntax

HRESULT Start(
  [in] WCHAR                       *pTargetServerName,
  [in] DWORD                       TargetSessionId,
  [in] BYTE                        HotKeyVk,
  [in] USHORT                      HotkeyModifiers,
  [in] IWRdsProtocolShadowCallback *pShadowCallback
);

Parameters

[in] pTargetServerName

A pointer to a string that contains the name of the shadowing server.

[in] TargetSessionId

An integer that specifies the ID of the target session to shadow.

[in] HotKeyVk

The virtual key code of the key that must be pressed to stop shadowing. This key is used in combination with the HotkeyModifiers parameter.

[in] HotkeyModifiers

The virtual modifier that specifies the modifier key to press to stop shadowing. Modifier keys include the Shift, Alt, and Ctrl keys. The modifier key is used in combination with the key signified by the HotKeyVk parameter.

[in] pShadowCallback

A pointer to an IWRdsProtocolShadowCallback interface that the protocol can use to call back into the Remote Desktop Services service.

Return value

When you are implementing this method, return S_OK if the function succeeds. If it fails, return an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

Remarks

The Remote Desktop Services service also changes the session state on the shadowed client to reflect the fact that it is being shadowed.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2012
Target Platform Windows
Header wtsprotocol.h

See also

IWRdsProtocolShadowConnection