Functions | |
TC_STATUS | TcBoardQueryPortList (TC_BOARD board, PTC_PORT *ppPorts, PULONG pLength) |
It queries a board for the list of physical ports that it contains. | |
TC_BOARD_TYPE | TcBoardGetType (TC_BOARD board) |
It returns the type of a given board. | |
PCHAR | TcBoardGetDescription (TC_BOARD board) |
It returns the description of a given board. | |
BOOLEAN | TcBoardIsEqual (TC_BOARD boardA, TC_BOARD boardB) |
It compares two board handles to check if they correspond to the same board. | |
TC_STATUS | TcBoardSetFeature (TC_BOARD board, ULONG feature, ULONG value) |
It sets a specific feature on the board. | |
TC_STATUS | TcBoardQueryFeature (TC_BOARD board, ULONG feature, PULONG pValue) |
It queries a specific feature on the board. |
It queries a board for the list of physical ports that it contains.
board | The handle of a board to query. | |
ppPorts | Address of a caller allocated pointer to a TC_PORT. On success, the pointer will point to an array of port handles in the board. The returned list must not be freed. | |
pLength | Address of a caller allocated unsigned long. On success, it contains the number of entries in the array of port handles ppPorts. |
Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.
TC_BOARD_TYPE TcBoardGetType | ( | TC_BOARD | board | ) |
It returns the type of a given board.
board | The handle of a board to query for the type. |
Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.
PCHAR TcBoardGetDescription | ( | TC_BOARD | board | ) |
It returns the description of a given board.
board | The handle of a board to get the description from. |
Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.
It compares two board handles to check if they correspond to the same board.
boardA | Handle to the first board | |
boardB | Handle to the second board |
Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.
It sets a specific feature on the board.
board | Board handle | |
feature | Identifier of the feature. A list of the available features can be found in section Features. | |
value | Value of the feature to be set. Please refer to the documentation of the specific feature you are trying to set in section Features. |
Thread safety: this function is thread safe i.e. it can be called from multiple threads concurrently.
It queries a specific feature on the board.
board | Board handle | |
feature | Identifier of the feature. A list of the available features can be found in section Features. | |
pValue | Pointer to a 32bit integer. On success it will return the value of the feature. Please refer to the documentation in section Features to know what values can be returned by querying a specific feature. |
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.