oracular (3) optionSaveFile.3.gz

NAME

       optionSaveFile - saves the option state to a file

SYNOPSIS

       #include <your-opts.h>
       cc [...] -o outfile infile.c -lopts [...]

       void optionSaveFile(tOptions * opts);

DESCRIPTION

       This  routine will save the state of option processing to a file.  The name of that file can be specified
       with the argument to the --save-opts option, or by appending the rcfile  attribute  to  the  last  homerc
       attribute.   If  no  rcfile  attribute  was specified, it will default to .programnamerc.  If you wish to
       specify another file, you should invoke the SET_OPT_SAVE_OPTS(filename) macro.

       The recommend usage is as follows:
           optionProcess(&progOptions, argc, argv);
           if (i_want_a_non_standard_place_for_this)
           SET_OPT_SAVE_OPTS("myfilename");
           optionSaveFile(&progOptions);

       opts   program options descriptor

ERRORS

       If no homerc file was specified, this routine will silently return and do nothing.  If  the  output  file
       cannot be created or updated, a message will be printed to stderr and the routine will return.

SEE ALSO

       The info documentation for the -lopts library.
       ao_string_tokenize(3),  configFileLoad(3), optionFileLoad(3), optionFindNextValue(3), optionFindValue(3),
       optionFree(3),    optionGetValue(3),    optionLoadLine(3),    optionMemberList(3),    optionNextValue(3),
       optionOnlyUsage(3),      optionPrintVersion(3),     optionPrintVersionAndReturn(3),     optionProcess(3),
       optionRestore(3),    optionSaveState(3),    optionUnloadNested(3),    optionVersion(3),     strequate(3),
       streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3),

                                                   2024-04-22                                  optionSaveFile(3)