Edit

IWTSSBPlugin::WTSSBX_SessionChangeNotification method (tssbx.h)

  • Article

[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, such as a logon, logoff, disconnect, or reconnect, occurred in the session.

Syntax

HRESULT WTSSBX_SessionChangeNotification(
  [in] WTSSBX_NOTIFICATION_TYPE NotificationType,
  [in] long                     MachineId,
  [in] DWORD                    NumOfSessions,
  [in] WTSSBX_SESSION_INFO []   SessionInfo
);

Parameters

[in] NotificationType

A WTSSBX_NOTIFICATION_TYPE type that specifies the type of change that occurred.

[in] MachineId

The ID of the server on which the session change occurred.

[in] NumOfSessions

The number of elements in the SessionInfo array.

[in] SessionInfo

An array of WTSSBX_SESSION_INFO structures that contain information about sessions. Only the members that have changed are reported in this structure. The others are set to zero.

Return value

Returns S_OK if successful.

Remarks

The WTSSBX_SessionChangeNotification method can report up to 25 sessions each time it is called. If Terminal Services Session Broker (TS Session Broker) needs to report more than 25 sessions, it calls this method multiple times until it reports all of its sessions.

Your implementation of this method 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

See also

ITsSbPlugin

IWTSSBPlugin