ar_interrupt_queue_read

int ar_hw_interrupt_buffer_read (short board, unsigned int * numberOfWords, unsigned int * data);

Purpose

This function provides read access directly to the CEI-x30 device hardware interrupt queue.  Each time this function is invoked, the specified number of queue entries will be read from the interrupt queue starting at the location referenced by last invocation of this function, and ending at the location indicated by the device interrupt queue pointer.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-15).

Output

 

 

Name

Type

Description

numberOfWords

unsigned int

(passed by reference)

(input/output) As an input, this argument specified the number of interrupt queue entries to read and return.  As an output, this argument indicates the number of interrupt queue entries actually read, if there were fewer unread entries available than what was requested.

data

unsigned int

(passed by reference)

(output) Interrupt Queue entries retrieved from the board.

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_GOTDATA      Routine execution was successful and one or more interrupt queue entries were returned.
ARS_NODATA        No unread interrupt queue entries were available or returned.
ARS_INVBOARD     The board parameter value is invalid.
ARS_INVARG         A NULL data buffer pointer was supplied.

References

Interrupt Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description