Aim MIL-STD-1553 - Apicmdbufread

MIL-STD-1553 Reference Manual
165
Chapter 5 – Buffer Functions
5.1.4 ApiCmdBufRead
Prototype:
AiInt16 ApiCmdBufRead ( AiUInt32 ul_ModuleHandle, AiUInt8 biu, AiUInt8 bt, AiUInt16 hid,
AiUInt16 bid, AiUInt8 len, AiUInt16 *data, AiUInt16 *rid,
AiUInt32 *raddr );
Driver Command:
API_BUF_READ (0x51)
Purpose:
This function reads the data buffer contents for transmit or receive messages in BC
and RT mode.
Input
A
A
i
i
U
U
I
I
n
n
t
t
8
8
b
b
t
t
Buffer type
Value
Constant
Description
1
API_BUF_BC_MSG
BC Message Buffer
2
API_BUF_RT_MSG
RT Message Buffer
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
h
h
i
i
d
d
Buffer Header ID
*Note: See Section 1.3.5 for the range allowed for this parameter.
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
b
b
i
i
d
d
‘hid’
Value
Constant
Description
0
1..n
Read Buffer Data Words from
absolute Data Buffer Index
Note: See section 1.3.5 for the
range allowed for this
parameter.
>0
0
API_BUF_READ_FROM_CURRENT
Read from current Data Buffer Index
>0
Read Buffer Data Words from Data
Buffer Index relative to the Data
Buffer Queue Base Index of the
specified Buffer Header Identifier.
0xffff
API_BUF_READ_FROM_LAST
Read from last Data Buffer Index
that received data
A
A
i
i
U
U
I
I
n
n
t
t
8
8
l
l
e
e
n
n
Value
Description
1..32
Amount of Data Buffer Words to read
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
*
*
d
d
a
a
t
t
a
a
Buffer Data Words to read