Initializing help system before first use

bindrv_putctrl

bindrv_putctrl

Purpose
Write a control token to the output stream.
Synopsis
int bindrv_putctrl(s_bindrvctx bctx, int val);
Arguments
bctx 
A BinDrv reader context
val 
Control code to write (value between 0 and 31)
Return value
0 if successful, 1 in case of an I/O error
Further information
1. A control code is represented by a 5bit integer (values 0 to 31) the interpretation of which is application-specific: the bindrv library does not use these control tokens. They are usually used as markers to structure the data flow: it is up to the user to define appropriate conventions according to his needs.
2. When generating a data stream to be parsed by a Mosel model, the following control codes must be used — they correspond to the control characters employed in the standard Mosel ascii file format:
BINDRV_CTRL_SKIP 
Skip entry (symbol '*' in ascii format)
BINDRV_CTRL_LABEL 
Start a new record: this control token is always followed by a string identifying the label (corresponds to 'label:' in ascii format)
BINDRV_CTRL_OPENLST 
Begin list of entries (symbol '[' in ascii format)
BINDRV_CTRL_CLOSELST 
End list of entries (symbol ']' in ascii format)
BINDRV_CTRL_OPENNDX 
Begin list of array indices (symbol '(' in ascii format)
BINDRV_CTRL_CLOSENDX 
End list of array indices (symbol ')' in ascii format)


Parent Topic Writer

© 2001-2020 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.