viPxiReserveTriggers
This section contains information specific to the Windows product.
Syntax
viPxiReserveTriggers(ViSession vi, ViInt16 cnt, ViAInt16 trigBuses, ViAInt16 trigLines, ViInt16 failureIndex);
Description
Reserve multiple trigger lines that the caller can then map and/or assert. This operation is valid only on PXI Backplane (BACKPLANE) sessions.
For a PXI BACKPLANE resource, viPxiReserveTriggers will reserve multiple triggers for later use by the client, such as for assertion and/or mapping. This operation is intended to be atomic, such that if it is not possible to simultaneously reserve all the requested bus/line pairs, then none of the bus/line pairs will be reserved.
Parameters
|
Name |
Dir |
Type |
Description |
|---|---|---|---|
|
vi |
IN |
ViSession |
Unique logical identifier to a session. |
|
cnt |
IN |
ViInt16 |
Number of trigger bus/line pairs to follow. |
|
trigBuses |
IN |
ViAInt16 |
Array of trigger buses. The size of this array is specified in cnt. |
|
trigLines |
IN |
ViAInt16 |
Array of trigger lines. The size of this array is specified in cnt. |
|
failureIndex |
OUT |
ViInt16 |
Specifies the 0-based index of the first trigger bus/line pair that could not be reserved. On success, this output parameter contains the value -1. |
Special Value for failureIndex Parameter |
|||
|
Value |
|
|
Action Description |
|
VI_NULL |
|
|
Do not return the index of the first failure. |
Return Values
|
Type ViStatus |
This is the function return status. It returns either a completion code or an error code as follows. |
|
Completion Code |
Description |
|---|---|
|
VI_SUCCESS |
Operation completed successfully. |
|
Error Code |
Description |
|
VI_ERROR_INV_SESSION |
The given session or object reference is invalid (both are the same value). |
|
VI_ERROR_NSUP_OPER |
The given vi does not support this operation. |
|
VI_ERROR_RSRC_LOCKED |
Specified operation could not be performed because the resource identified by vi has been locked for this kind of access. |
|
VI_ERROR_INV_LENGTH |
Invalid count specified. |
|
VI_ERROR_IO |
Could not perform operation because of I/O error. |
|
VI_ERROR_LINE_IN_USE |
One of the specified lines is currently in use. |
|
VI_ERROR_INV_LINE |
One of the specified lines is invalid. |
|
VI_ERROR_NSUP_LINE |
One of the specified lines is not supported by this VISA implementation. |
See Also
BACKPLANE Resource Description