Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
optionLoadLine(3)	      Programmer's Manual	     optionLoadLine(3)

NAME
       optionLoadLine -	process	a string for an	option name and	value

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

       void optionLoadLine(tOptions * opts, char const * line);

DESCRIPTION
       This is a client	program	callable routine for setting options from, for
       example,	the contents of	a file that they read in.  Only	one option may
       appear  in  the	text.	It  will  be  treated as a normal (non-preset)
       option.

       When passed a pointer to	the option struct and a	string,	it  will  find
       the  option  named  by the first	token on the string and	set the	option
       argument	to the remainder of the	string.	 The caller must NUL terminate
       the  string.   The  caller need not skip	over any introductory hyphens.
       Any embedded new	lines will be included in the option argument.	If the
       input  looks  like  one	or more	quoted strings,	then the input will be
       "cooked".  The "cooking"	is identical to	the string formation  used  in
       AutoGen	definition  files  (@pxref{basic expression}), except that you
       may not use backquotes.

       opts   program options descriptor

       line   NUL-terminated text

ERRORS
       Invalid options are silently ignored.  Invalid  option  arguments  will
       cause a warning to print, but the function should return.

SEE ALSO
       The info	documentation for the -lopts library.
       ao_string_tokenize(3),  configFileLoad(3),  optionFileLoad(3),  option-
       FindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3),
       optionMemberList(3),  optionNextValue(3),  optionOnlyUsage(3),  option-
       PrintVersion(3),	  optionPrintVersionAndReturn(3),    optionProcess(3),
       optionRestore(3),  optionSaveFile(3), optionSaveState(3), optionUnload-
       Nested(3), optionVersion(3), strequate(3), streqvcmp(3),	 streqvmap(3),
       strneqvcmp(3), strtransform(3),

				  2017-07-02		     optionLoadLine(3)

NAME | SYNOPSIS | DESCRIPTION | ERRORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=optionLoadLine&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help