IWTSSBPlugin::WTSSBX_MachineChangeNotification method

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

Notifies the plug-in that a change occurred in the server environment.

Syntax


HRESULT WTSSBX_MachineChangeNotification(
  [in] WTSSBX_NOTIFICATION_TYPE NotificationType,
  [inlong                     MachineId,
  [in] WTSSBX_MACHINE_INFO      *pMachineInfo
);

Parameters

NotificationType [in]

A value of the WTSSBX_NOTIFICATION_TYPE enumeration type that indicates the type of event that occurred.

MachineId [in]

The ID of the server on which the change occurred.

pMachineInfo [in]

A pointer to a WTSSBX_MACHINE_INFO structure that contains information about the server that changed. Only the members that changed are reported in this structure. The other members are set to zero.

Return value

Returns S_OK if successful.

Remarks

Terminal Services Session Broker (TS Session Broker) calls this method whenever an important change in the server environment occurs. For example, changes that would trigger a call include when:

  • A server joins or leaves a farm in TS Session Broker.
  • A server changes its drain state.
  • A server IP address changes.
  • A server's maximum session limit changes.

Your implementation of this method must return S_OK immediately if successful.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

End of server support

Windows Server 2008 R2

Header

Tssbx.h

IDL

Tssbx.idl

IID

IID_IWTSSBPlugin is defined as DC44BE78-B18D-4399-B210-641BF67A002C

See also

IWTSSBPlugin
ITsSbPlugin

 

 

Show: