Arguments

Files
file	psArguments.h
	Contains operations for parsing command line input arguments.
Functions
int	psArgumentVerbosity (int *argc, char **argv)
	Implements the various verbosity controls.
int	psArgumentGet (int argc, char **argv, const char *arg)
	Checks for an argument and returns its index position if found.
bool	psArgumentRemove (int argnum, int *argc, char **argv)
	Removes from the argument list the argument whose index is argnum.
bool	psArgumentParse (psMetadata *arguments, int *argc, char **argv)
	Parses the command line arguments into a metadata container of arguments.
void	psArgumentHelp (psMetadata *arguments)
	Prints to stdout a guide to the command-line arguments.
psS32	psLogArguments (int *argc, char **argv)
	Sets the log level.
psS32	psTraceArguments (int *argc, char **argv)
	Sets trace levels by facility.

---

Function Documentation

int psArgumentGet (  int  argc, char **  argv, const char *  arg )

Checks for an argument and returns its index position if found. Returns: int: The index of the element in the argument list, otherwise 0. Parameters: argc  number of arguments argv  the argument list arg  the specified argument to match

void psArgumentHelp (  psMetadata *  arguments  )

Prints to stdout a guide to the command-line arguments. Parameters: arguments  metadata container for arguments

bool psArgumentParse (  psMetadata *  arguments, int *  argc, char **  argv )

Parses the command line arguments into a metadata container of arguments. The input arguments shall contain the list of possible arguments as the keywords providing the default values. As matching arguments are found on the command line, the values shall be read into the arguments metadata, with the appropriate type. The arguments and their values shall be removed from the list of command line arguments as they are processed. Returns: bool: False if any argument was encountered that is not present in arguments. Parameters: arguments  metadata container for arguments argc  number of arguments argv  the argument list

bool psArgumentRemove (  int  argnum, int *  argc, char **  argv )

Removes from the argument list the argument whose index is argnum. The number of entries in the argument list shall be decremented. Returns: bool: True if the argnum is in the argument list, otherwise false. Parameters: argnum  the argument to remove argc  number of arguments argv  the argument list

int psArgumentVerbosity (  int *  argc, char **  argv )

Implements the various verbosity controls. Arguments shall be removed from the argument list as they are processed. Returns: int: The resultant logging level. Parameters: argc  number of arguments argv  the argument list

psS32 psLogArguments (  int *  argc, char **  argv )

Sets the log level. Returns: psS32: the log level. Parameters: argc  number of arguments argv  the argument list

psS32 psTraceArguments (  int *  argc, char **  argv )

Sets trace levels by facility. Returns: psS32: 1 (true) if successful or else 2. Parameters: argc  number of arguments argv  the argument list

---