Aim MIL-STD-1553 - Apiwaitforscopefinished

MIL-STD-1553 Reference Manual
414
Chapter 9 – Bus Monitor Functions
9.1.46 ApiWaitForScopeFinished
Prototype:
AiInt16 ApiWaitForScopeFinished(
AiUInt32 ulModuleHandle,
AiInt32 lTimeOut,
TY_API_SCOPE_WAIT_STATE* pWaitResultFlags);
Purpose:
In single shot mode this function blocks the current execution thread until all the
buffers are filled or the specified timeout occurred.
Note: This function is only usable with AIM’s APE MIL-Scope module.
I
I
n
n
p
p
u
u
t
t
l
l
T
T
i
i
m
m
e
e
O
O
u
u
t
t
Time-out in milliseconds.
Value
Description
-1
Infinite blocking
0
Function returns at once.
>0
Time-out in milliseconds
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
_
_
W
W
A
A
I
I
T
T
_
_
S
S
T
T
A
A
T
T
E
E
*
*
p
p
W
W
a
a
i
i
t
t
R
R
e
e
s
s
u
u
l
l
t
t
F
F
l
l
a
a
g
g
s
s
Pointer to value where flags according to wait result are set
typedef AiUInt32 TY_API_SCOPE_WAIT_STATE
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..
Flag
Description
SCOPE_WAIT_FINISHED
Scope has finished, all scope buffers have been
processed
SCOPE_WAIT_TIMEOUT
Scope is still running. The specified time out elapsed.
SCOPE_WAIT_OVERFLOW
Scope is idle but Overflow in scope data capturing
occurred.