IWTSSBPlugin::Initialize method (tssbx.h)

Article
02/22/2024

[The IWTSSBPlugin interface is not supported after Windows Server 2008 R2. Starting with Windows Server 2012 please use the ITsSbPlugin interface.]

Initializes the plug-in and returns a value that indicates the redirection capabilities of the plug-in. Terminal Services Session Broker (TS Session Broker) calls this method immediately after it instantiates the plug-in class.

Syntax

HRESULT Initialize(
  [out] DWORD *PluginCapabilities
);

Parameters

[out] PluginCapabilities

A pointer to a value that indicates the redirection capabilities of the plug-in.

0

The plug-in redirects only within a farm in TS Session Broker. If this value is returned, TS Session Broker does not call the WTSSBX_GetUserExternalSession method on the plug-in.

1

The plug-in redirects within a farm in TS Session Broker, and the plug-in implements WTSSBX_GetUserExternalSession to redirect outside the farm.

Return value

Returns S_OK if successful.

Remarks

TS Session Broker calls Initialize immediately after it instantiates the COM class. The plug-in should return information about its redirection capabilities by using the Initialize method.

Your implementation of Initialize must return S_OK immediately if successful.

Requirements

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

Share via