Initializing help system before first use

XPRMcb_sendstring

XPRMcb_sendstring


Purpose
Send a text string value to an initialization stream.
Synopsis
int XPRMcb_sendstring(XPRMcbinit cbinit,const char *text, int len,int flush);
Arguments
cbinit 
Stream context
text 
Text string value to send
len 
Length of the string (or -1)
flush 
If 0, the data will be processed when the queue of tokens is full, otherwise processing occurs immediately.
Return value
Normal termination
All tokens have been processed and no more data is expected
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