Aim MIL-STD-1553 - Apicmddataqueueread

MIL-STD-1553 Reference Manual
379
Chapter 9 – Bus Monitor Functions
9.1.27 ApiCmdDataQueueRead
Prototype:
ApiCmdDataQueueRead( AiUInt32 ul_ModuleHandle,
TY_API_DATA_QUEUE_READ *px_QueueData );
Driver Command:
none
Purpose:
This function is used to read data from a previously created data queue.
I
I
n
n
p
p
u
u
t
t
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
D
D
A
A
T
T
A
A
_
_
Q
Q
U
U
E
E
U
U
E
E
_
_
R
R
E
E
A
A
D
D
*
*
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
Pointer to the TY_API_DATA_QUEUE_READ structure
typedef struct ty_api_data_queue_status
{
AiUInt32 ul_Status;
AiUInt32 ul_BytesTransferred;
AiUInt32 ul_BytesInQueueLo;
AiUInt32 ul_BytesInQueueHi;
AiUInt32 ul_TotalBytesTransferredLo;
AiUInt32 ul_TotalBytesTransferredHi;
} TY_API_DATA_QUEUE_STATUS;
typedef struct ty_api_data_queue_read
{
AiUInt8 uc_Id;
AiUInt8 uc_Padding1;
AiUInt16 uw_Padding2;
void *pv_MemBuf;
AiUInt32 ul_BytesToRead;
TY_API_DATA_QUEUE_STATUS x_Info; (see output description)
} TY_API_DATA_QUEUE_READ;
A
A
i
i
U
U
I
I
n
n
t
t
8
8
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
-
-
>
>
u
u
c
c
_
_
I
I
d
d
Unique Queue Id representing the data queue to read from.
See description of the parameter px_Queue->uc_Id in the function
ApiCmdDataQueueOpen.
A
A
i
i
U
U
I
I
n
n
t
t
8
8
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
-
-
>
>
u
u
c
c
_
_
P
P
a
a
d
d
d
d
i
i
n
n
g
g
1
1
0 (reserved)
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
-
-
>
>
u
u
w
w
_
_
P
P
a
a
d
d
d
d
i
i
n
n
g
g
2
2
0 (reserved)
v
v
o
o
i
i
d
d
*
*
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
-
-
>
>
p
p
v
v
_
_
M
M
e
e
m
m
B
B
u
u
f
f
Pointer to the application memory where the data that was read is stored.
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
-
-
>
>
u
u
l
l
_
_
B
B
y
y
t
t
e
e
s
s
T
T
o
o
R
R
e
e
a
a
d
d
Amount of bytes to be read from the data queue
Note: A value of 0 in ‘ul_BytesToRead’ can be used to read the data queue
status !
O
O
u
u
t
t
p
p
u
u
t
t
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
D
D
A
A
T
T
A
A
_
_
Q
Q
U
U
E
E
U
U
E
E
_
_
R
R
E
E
A
A
D
D
*
*
p
p
x
x
_
_
Q
Q
u
u
e
e
u
u
e
e
D
D
a
a
t
t
a
a
Pointer to the TY_API_DATA_QUEUE_READ structure
typedef struct ty_api_data_queue_status
{
AiUInt32 ul_Status;