Aim MIL-STD-1553 - 11.1 Low Speed Functions

MIL-STD-1553 Reference Manual
410
Chapter 9 – Bus Monitor Functions
9.1.43 ApiCreateScopeBufferList
Prototype:
AiInt16 ApiCreateScopeBufferList(
AiUInt32 ulModuleHandle,
AiUInt32 ulNumBuffers,
TY_API_SCOPE_BUFFER* paxBufferList[],
TY_API_SCOPE_BUFFER_HANDLER pBufferHandler,
void* pvUserData);
Purpose:
This function allocates a list of scope buffers which can be used as input to the
function ApiProvideScopeBuffers. The MILScope data will be transferred directly
into this buffer with a DMA transfer. The buffer will be allocated with the required
size, channel flag and order according to the MILScope setup. Before this function is
called the function ApiCmdScopeSetup must be called.
Note: This function is only usable with AIM’s APE MIL-Scope module.
I
I
n
n
p
p
u
u
t
t
A
A
i
i
U
U
I
I
n
n
t
t
3
3
2
2
u
u
l
l
N
N
u
u
m
m
B
B
u
u
f
f
f
f
e
e
r
r
s
s
Number of scope buffers to create for the list. In single channel mode, this has to be a multiple of 2, while in
dual channel mode this has to be a multiple of 4.
T
T
Y
Y
_
_
A
A
P
P
I
I
_
_
S
S
C
C
O
O
P
P
E
E
_
_
B
B
U
U
F
F
F
F
E
E
R
R
_
_
H
H
A
A
N
N
D
D
L
L
E
E
R
R
p
p
B
B
u
u
f
f
f
f
e
e
r
r
H
H
a
a
n
n
d
d
l
l
e
e
r
r
Function pointer of type TY_API_SCOPE_BUFFER_HANDLER. This handler function is set for all of the
buffers in the list.
See description of ApiProvideScopeBuffer.
v
v
o
o
i
i
d
d
*
*
p
p
v
v
U
U
s
s
e
e
r
r
D
D
a
a
t
t
a
a
Pointer to user definable data which is attached to the scope buffers. This data can be accessed in the
scope buffer handler when buffer is completed or canceled.
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
_
_
B
B
U
U
F
F
F
F
E
E
R
R
*
*
p
p
a
a
x
x
B
B
u
u
f
f
f
f
e
e
r
r
L
L
i
i
s
s
t
t
[
[
]
]
Array of pointers to TY_API_SCOPE_BUFFER structures which forms the actual scope buffer list. You have
to ensure this array has at least ulNumBuffers entries. See description of ApiProvideScopeBuffer.
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..