company logo

FileHandle :: FOut - Write line to file handle with indent

The function writes a line to the output file. The format line passed may contain %s place holders. For each place holder a string must be added to the parameter list, which will replace the %s value in the format string.

In addition to Out() , the function supports indenting. Before writing the line, spaces are inserted according to the indent level (number of Indent() calls) multiplied with the indent size set with IndentSize() .

The format string may contain escape sequences ( \n, \t and \r ), which will be converted in appropriate ASCII control sequences (line break, tab).

There are two implementations, one with maximum 3 string parameter and one with exact 16. OSI applications may call the function with any number of string parameters between 0 and 16.

Notes:

Escape sequences passed in parameters are NOT converted.

Return value:  Success ( logical  )

Implementation details

  1. Extended formatted output
    logical FileHandle  :: FOut ( NString &format_string, NString &parm1, NString &parm2, NString &parm3, NString &parm4, NString &parm5, NString &parm6, NString &parm7, NString &parm8, NString &parm9, NString &parm10, NString &parm11, NString &parm12, NString &parm13, NString &parm14, NString &parm15, NString &parm16 )

    The function is called with 16 replacement parameters. String parameters not used have to be passed as empty strings.

    • format_string - Format string

      The format string defines the pattern for the output string. It may contain fixed text and place holders (%s). Place holders are replaced by the string values passed as parameters in the sequence as being passed to the function.

    • parm1 - String parameter
    • parm2 - String parameter
    • parm3 - String parameter
    • parm4 - String parameter
    • parm5 - String parameter
    • parm6 - String parameter
    • parm7 - String parameter
    • parm8 - String parameter
    • parm9 - String parameter
    • parm10 - String parameter
    • parm11 - String parameter
    • parm12 - String parameter
    • parm13 - String parameter
    • parm14 - String parameter
    • parm15 - String parameter
    • parm16 - String parameter
  2. to list
  3. Default formatted output
    logical FileHandle  :: FOut ( NString &format_string, NString &parm1_w=NString::Null(), NString &parm2_w=NString::Null(), NString &parm3_w=NString::Null() )

    The default implementations may be called with 0-3 string valued for the format string.

    • format_string - Format string

      The format string defines the pattern for the output string. It may contain fixed text and place holders (%s). Place holders are replaced by the string values passed as parameters in the sequence as being passed to the function.

    • parm1_w - - internal feature (not documented) Default: NString::Null()
    • parm2_w - - internal feature (not documented) Default: NString::Null()
    • parm3_w - - internal feature (not documented) Default: NString::Null()
  4. to list