XPRMcb_sendctrl
XPRMcb_sendctrl |
Purpose
Send a control character to an initialization stream.
Synopsis
int XPRMcb_sendctrl(XPRMcbinit cbinit,int ctrl,int flush);
Arguments
|
cbinit
|
Stream context
|
||||||||||
|
ctrl
|
Control character code. Possible values:
|
||||||||||
|
flush
|
If
0, the data will be processed when the queue of tokens is full, otherwise processing occurs immediately.
|
Return value
|
0
|
Normal termination
|
|
1
|
All tokens have been processed and no more data is expected
|
|
2
|
No more data is expected but the queue of tokens is not empty
|
|
-1
|
An error occurred
|
Further information
1. This function can only be used from a callback stream (see Section
cb driver) during the execution of an
initializations from block.
2. If the
flush argument is
0, the information sent is queued and the function returns
0. The queue is flushed when it is full or if the
flush argument is non-zero.
Related topics