OSFI-C  3.10.0
OpenSF Integration Library
osfi_clp_args Struct Reference

Result of parsing CLI arguments, contains the files of each type passed to the module. More...

#include <OSFIC.h>

Data Fields

osfi_clp_files_tconfig
 Configuration files, never null. More...
 
osfi_clp_files_tinput
 Input files, never null.
 
osfi_clp_files_toutput
 Output files, never null.
 

Detailed Description

Result of parsing CLI arguments, contains the files of each type passed to the module.

On a successful return from osfiClpParseArgs(), all members will point to a valid (non-null) substructure. However, depending on the actual arguments, some of them may contain 0 entries e.g. if no input files exist then input is allocated but input->count==0.

See also
osfiClpFree() to release the resources.
Examples
CLP.c.

Field Documentation

◆ config

osfi_clp_files_t* osfi_clp_args::config

Configuration files, never null.

The number of files available in this member depends on the type of arguments parsed:

  • Flag-type arguments always result in exactly two entries in the order (global, local). If one of them was not given, it is represented by an empty string.
  • However, positional arguments are parsed as-is, resulting into one entry for each file given in the argument, or even zero entries for an empty argument.

The documentation for this struct was generated from the following file: