Initializing help system before first use

# 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

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
XPRMcb_sendint, XPRMcb_sendreal, XPRMcb_sendctrl.
Parent Topic Post processing interface

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.