ar_hw_interrupt_buffer_read

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

Purpose

This function provides read access to the local API copy of the CEI-x30 device interrupt queue.  The local API copy is filled by hardware interrupt processing within the default API ISR.  If the host application replaces the default API ISR with a custom ISR, this function is not usable.

Each time this function is invoked, the specified number of queue entries is read from the buffer region starting at the location last referenced by the API in a previous invocation and ending at the location written by the most recent execution of the default API interrupt service routine.  

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 buffer entries to read and return.  As an output, this argument indicates the number of interrupt buffer entries actually read, if there were fewer unread entries available than what was requested.

data

unsigned int

(passed by reference)

(output) Interrupt Queue buffered entries retrieved from the API.

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 buffer entries were returned.
ARS_NODATA        No unread interrupt buffer entries were available or returned.
ARS_INVBOARD     The board parameter value was invalid.
ARS_INVARG         A NULL data buffer pointer was supplied.

References

Interrupt Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description