ITsSbOrchestration::PrepareTargetForConnect method (sbtsv.h)

Article
02/22/2024

Prepares the target for a client connection.

Syntax

HRESULT PrepareTargetForConnect(
  [in] ITsSbClientConnection        *pConnection,
  [in] ITsSbOrchestrationNotifySink *pOrchestrationNotifySink
);

Parameters

[in] pConnection

A pointer to an ITsSbClientConnection client connection object.

[in] pOrchestrationNotifySink

A pointer to an ITsSbOrchestrationNotifySink orchestration notify sink object.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method is particularly useful for plug-ins that redirect users to virtual desktops. Remote Desktop Connection Broker (RD Connection Broker) calls this method after placement has successfully completed. Orchestration can include waking a virtual machine and determining its IP address. Your implementation of this method should ensure that the target is ready to accept a client connection.

Requirements

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