Aim MIL-STD-1553 - Apicmdtrackread

MIL-STD-1553 Reference Manual
128
Chapter 3 – System Functions
3.1.30 ApiCmdTrackRead
Prototype:
AiInt16 ApiCmdTrackRead ( AiUInt32 ul_ModuleHandle, AiUInt8 biu,
AiUInt8 uc_TrackId, AiUInt16 uw_MultiplexedTrackIndex,
AiUInt8 uc_ReadMode, AiUInt8 *puc_DataValid,
AiUInt16 *puw_TrackDataWords );
Driver Command:
API_TRACK_READ (0x2D)
Purpose:
This function is used to read all or specific tracks from a previously defined Track
Multiplex Buffer defined using ApiCmdTrackDef/ApiCmdTrackDefEx.
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
u
u
c
c
_
_
T
T
r
r
a
a
c
c
k
k
I
I
d
d
Value
Description
0..255
Track Multiplex Buffer Identifier
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
u
u
w
w
_
_
M
M
u
u
l
l
t
t
i
i
p
p
l
l
e
e
x
x
e
e
d
d
T
T
r
r
a
a
c
c
k
k
I
I
n
n
d
d
e
e
x
x
Value
Description
0..65535
Track Index into the Track Multiplex Buffer to read from
Note: It is the responsibility of the application to make sure that the Track
Index does not exceed the length of the Track Multiplex Buffer
(uw_MultiplexedTrackNb) defined in ApiCmdTrackDef.
A
A
i
i
U
U
I
I
n
n
t
t
8
8
u
u
c
c
_
_
R
R
e
e
a
a
d
d
M
M
o
o
d
d
e
e
Value
Constant
Description
0
API_TRACK_DONT_CLR_UDF
Do not clear track update flag
1
API_TRACK_CLR_UDF
Clear track update flag after read
O
O
u
u
t
t
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
8
8
*
*
p
p
u
u
c
c
_
_
D
D
a
a
t
t
a
a
V
V
a
a
l
l
i
i
d
d
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
NOMEM
VALID
N
N
O
O
M
M
E
E
M
M
If set to 1, the requested multiplex state could not be defined due to low memory
V
V
A
A
L
L
I
I
D
D
Value
Constant
Description
0
API_DATA_NOT_VALID
Returned data is not valid (e.g. track
buffer did not receive anything yet)
1
API_DATA_VALID
Data is valid
A
A
i
i
U
U
I
I
n
n
t
t
1
1
6
6
*
*
p
p
u
u
w
w
_
_
T
T
r
r
a
a
c
c
k
k
D
D
a
a
t
t
a
a
W
W
o
o
r
r
d
d
s
s
Pointer to the Track Multiplex Buffer at the requested Track Index.