TUPDeleteCircuit

Sends a request to delete the given circuit.

Prototype

S16 TUPDeleteCircuit ( U8 board, CirIdx circID, U32 count)

Argument

Description

board

TX board number.

circID

Circuit index at which to start deleting.

count

Number of circuits to delete.


Return values

Return value

Description

TUP_SUCCESS

 

TUP_BOARD

board is out of range.

TUP_DRIVER

Error occurred accessing the driver.

TUP_FAILED

Task on the TX board reported a failure.

TUP_UNBOUND

Application failed to call TUPInitMgmtAPI prior to this call.


Details

Set circId and count to 0 to delete all circuits that are not part of a predefined group. Call TUPDeleteGroup with groupId 0 before calling TUPDeleteCircuit to delete all circuits.