ITsSbPlacement::QueryEnvironmentForTarget method (sbtsv.h)

Article
02/22/2024

Determines whether the specified environment is ready to host the target that was returned by load balancing.

Syntax

HRESULT QueryEnvironmentForTarget(
  [in] ITsSbClientConnection    *pConnection,
  [in] ITsSbPlacementNotifySink *pPlacementSink
);

Parameters

[in] pConnection

A pointer to an ITsSbClientConnection client connection object.

[in] pPlacementSink

A pointer to an ITsSbPlacementNotifySink placement sink object.

Return value

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

Remarks

Your plug-in should use the ITsSbPlacementNotifySink object to report the state of the environment to Remote Desktop Connection Broker (RD Connection Broker).

After RD Connection Broker receives a load-balancing result, it calls QueryEnvironmentForTarget to determine whether the environment is present and ready.

Requirements

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