Edit

TcRegisterClient function (traffic.h)

  • Article

The TcRegisterClient function is used to register a client with the traffic control interface (TCI). The TcRegisterClient function must be the first function call a client makes to the TCI.

Client registration provides callback routines that allow the TCI to complete either client-initiated operations or asynchronous events. Upon successful registration, the caller of the TcRegisterClient function must be ready to have any of its TCI handlers called. See Entry Points Exposed by Clients of the Traffic Control Interface for more information.

Syntax

ULONG TcRegisterClient(
  [in]  ULONG                 TciVersion,
  [in]  HANDLE                ClRegCtx,
  [in]  PTCI_CLIENT_FUNC_LIST ClientHandlerList,
  [out] PHANDLE               pClientHandle
);

Parameters

[in] TciVersion

Traffic control version expected by the client, included to ensure compatibility between traffic control and the client. Clients can pass CURRENT_TCI_VERSION, defined in Traffic.h.

[in] ClRegCtx

Client registration context. ClRegCtx is returned when the client's notification handler function is called. This can be a container to hold an arbitrary client-defined context for this instance of the interface.

[in] ClientHandlerList

Pointer to a list of client-supplied handlers. Client-supplied handlers are used for notification events and asynchronous completions. Each completion routine is optional, with the exception of the notification handler. Setting the notification handler to NULL will return an ERROR_INVALID_PARAMETER.

[out] pClientHandle

Pointer to the buffer that traffic control uses to return a registration handle to the client.

Return value

Return code Description
NO_ERROR
 The function executed without errors.
ERROR_NOT_ENOUGH_MEMORY
 The system is out of memory.
ERROR_INVALID_PARAMETER
 One of the parameters is NULL.
ERROR_INCOMPATIBLE_TCI_VERSION
 The TCI version is wrong.
ERROR_OPEN_FAILED
 Traffic control failed to open a system device. The likely cause is insufficient privileges.
ERROR_TOO_MANY_CLIENTS
 Traffic Control was unable to register with the kernel component GPC. The likely cause is too many traffic control clients are currently connected.

Windows 2000:  This value is not supported.

Remarks

Some of the return codes can be found in tcerror.h.

Note  Use of the TcRegisterClient function requires administrative privilege.
 

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header traffic.h
Library Traffic.lib
DLL Traffic.dll