www.LinuxHowtos.org

optionSaveFile

Section: Programmer's Manual (3)
Updated: 2016-10-27
Index Return to Main Contents

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.