Aim MIL-STD-1553 - Apicmdscopestatus

MIL-STD-1553 Reference Manual
395
Chapter 9 – Bus Monitor Functions
9.1.35 ApiCmdScopeStatus
Prototype:
AiInt16 ApiCmdScopeStatus( AiUInt32 ul_ModuleHandle,TY_API_SCOPE _STATUS*
peStatus, AiUInt32* pulNumBuffersLeft );
Driver Command:
none
Purpose:
This function returns the current statue of the APE-MIL-Scope. The function of not
yet filled buffers is returned as well.
Note: This function is only usable with AIM’s APE MIL-Scope module.
I
I
n
n
p
p
u
u
t
t
n
n
o
o
n
n
e
e
O
O
u
u
t
t
p
p
u
u
t
t
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
S
S
C
C
O
O
P
P
E
E
_
_
S
S
T
T
A
A
T
T
U
U
S
S
*
*
p
p
e
e
S
S
t
t
a
a
t
t
u
u
s
s
Current MIL-Scope status.
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
*
*
p
p
u
u
l
l
N
N
u
u
m
m
B
B
u
u
f
f
f
f
e
e
r
r
s
s
L
L
e
e
f
f
t
t
Number of buffers that are still free for Scope data.
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.
Enum Value
Description
SCOPE_STATUS_WAIT_FOR_TRIGGER
Scope is started and waiting for trigger
SCOPE_STATUS_TRIGGERED
Scope was triggered and is now recording scope
data
SCOPE_STATUS_STOPPED
Scope was stopped, either through call of
ApiCmdScopeStop or due to all buffers being filled
in single-shot mode
SCOPE_STATUS_OVERFLOW
Scope buffers ran out while recording scope data.
Scope is stopped now