Edit

IWTSProtocolShadowCallback::InvokeTargetShadow method (wtsprotocol.h)

  • Article

[IWTSProtocolShadowCallback::InvokeTargetShadow is no longer available for use as of Windows Server 2012. Instead, use IWRdsProtocolShadowCallback::InvokeTargetShadow.]

Instructs the Remote Desktop Services service to begin the target side of the shadow and passes any information that must be exchanged between the client and the target.

Syntax

HRESULT InvokeTargetShadow(
  [in] WCHAR *pTargetServerName,
  [in] ULONG TargetSessionId,
  [in] PBYTE pParam1,
  [in] DWORD Param1Size,
  [in] PBYTE pParam2,
  [in] DWORD Param2Size,
  [in] PBYTE pParam3,
  [in] DWORD Param3Size,
  [in] PBYTE pParam4,
  [in] DWORD Param4Size,
  [in] WCHAR *pClientName
);

Parameters

[in] pTargetServerName

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

[in] TargetSessionId

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

[in] pParam1

A pointer to a byte that contains an arbitrary parameter.

[in] Param1Size

An integer that contains the size, in bytes, of the value referenced by the pParam1 parameter.

[in] pParam2

A pointer to a byte that contains an arbitrary parameter.

[in] Param2Size

An integer that contains the size, in bytes, of the value referenced by the pParam2 parameter.

[in] pParam3

A pointer to a byte that contains an arbitrary parameter.

[in] Param3Size

An integer that contains the size, in bytes, of the value referenced by the pParam3 parameter.

[in] pParam4

A pointer to a byte that contains an arbitrary parameter.

[in] Param4Size

An integer that contains the size, in bytes, of the value referenced by the pParam4 parameter.

[in] pClientName

A pointer to a string that contains the name of the shadow client.

Return value

If the function succeeds, the function returns S_OK.

If the function fails, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following list. For a list of common error codes, see Common HRESULT Values.

Remarks

The four parameters pParam1, pParam2, pParam3, and pParam4 can contain any information that must be exchanged between the shadow client and the shadow target. The Remote Desktop Services service passes the information without modification.

Requirements

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

See also

IWTSProtocolShadowCallback