Aim MIL-STD-1553 - Apicmddataqueuecontrol

MIL-STD-1553 Reference Manual
375
Chapter 9 – Bus Monitor Functions
9.1.25 ApiCmdDataQueueControl
Prototype:
ApiCmdDataQueueControl( AiUInt32 ul_ModuleHandle,
TY_API_DATA_QUEUE_CONTROL *px_QueueControl );
Driver Command:
none
Purpose:
This function is used to control a 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_control
{
AiUInt8 uc_Id ;
AiUInt8 uc_Mode ;
} TY_API_DATA_QUEUE_CONTROL;
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 be controlled
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
_
_
M
M
o
o
d
d
e
e
Control Mode
Value
Constant
Description
0
API_DATA_QUEUE_CTRL_MODE_START
Start the data capturing of the data queue
Note: The data queue will be flushed before
starting data capturing!
1
API_DATA_QUEUE_CTRL_MODE_STOP
Stop the data queue from data capturing
Note: Data which is already in the Queue can
still be read by the application!
2
API_DATA_QUEUE_CTRL_MODE_RESUME
Continue data capturing of a previously stopped
data queue
Note: The data queue will not be flushed
before starting data capturing.
Therefore the data may be inconsistent!
3
API_DATA_QUEUE_CTRL_MODE_FLUSH
Flush the data queue
Note: All stored data within the data queue
will be lost!
O
O
u
u
t
t
p
p
u
u
t
t
n
n
o
o
n
n
e
e
Return Value
A
A
i
i
I
I
n
n
t
t
1
1
6
6
All API functions return API_OK if no error occurred. If the return value is not
equal to API_OK the function ApiGetErrorDescription can be used to obtain an
error description.