Global functions

Functions

TC_STATUS TcQueryPortList (PTC_PORT *ppPorts, PULONG pLength)
 It returns a list on all the available ports on the system, both physical and aggregating (TcAP and BAP).
TC_STATUS TcFreePortList (PTC_PORT pPorts)
 It frees a list of port handles returned by TcQueryPortList .
PCHAR TcStatusGetString (TC_STATUS status)
 It translates a status code returned by one of the functions into an error string.

Function Documentation

TC_STATUS TcQueryPortList ( PTC_PORT ppPorts,
PULONG  pLength 
)

It returns a list on all the available ports on the system, both physical and aggregating (TcAP and BAP).

Parameters:
ppPorts Address of a caller allocated pointer to a TC_PORT. On success, the pointer will point to an array of port handles available on the system. The returned list must be freed with TcFreePortList.
pLength Address of a caller allocated unsigned long. On success, it contains the number of entries in the array of port handles ppPorts.
Returns:
One of the Error codes values.

Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.

TC_STATUS TcFreePortList ( PTC_PORT  pPorts  ) 

It frees a list of port handles returned by TcQueryPortList .

Parameters:
pPorts A list of port handles previously returned by TcQueryPortList .
Returns:
One of the Error codes values.

Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.

PCHAR TcStatusGetString ( TC_STATUS  status  ) 

It translates a status code returned by one of the functions into an error string.

Parameters:
status A status code (in the Error codes section) returned by one of functions in the library.
Returns:
A constant string describing the error. The returned string must not be released or modified.

Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.


TurboCap API documentation. Copyright (c) 2007-2008 CACE Technologies. All rights reserved.