Infrasctucture Util Function Reference

Util
Utilities module.

getId     IDREG     utInit     usage     Usage    

int  getId( char* buf )
Retrieve a list of all CVS Ids registered with the util layer using IDREG. The list will be concatenated into the caller supplied buf array, each line with a NEWLINE terminator. The caller must supply an array large enough to hold all the CVS IDs and the first character of the array must be a NULL terminator.

int  IDREG( char* $Id: Util.xml,v 1.2 2007/07/11 14:12:15 pturner Exp $ )
Register the CVS Id string so that it can be displayed by the infCtl tool. The argument must be the string "$Id: Util.xml,v 1.2 2007/07/11 14:12:15 pturner Exp $". When this module is checked into CVS, the string "$Id: Util.xml,v 1.2 2007/07/11 14:12:15 pturner Exp $" will have the CVS Id inserted just in front of the last "$".

int  utInit( int argc, char** argv )
Initialize the Utilities layer. This registers the Util layer's CVS Id for later display, then calls the initialization function for each layer within libUt. The arguments argc and argv are the same as main(). If libUt lyers use any command line options they will be removed from argv and argc will be decremented. The remaining argc will be returned.

int  usage( char* cmd, char** msgArry, pfi_t func )
Output a usage message to user, displaying a list of command line options, call an optional call-back function to clean up, then exit. The argunent "cmd" is the ascii command name. The argument "MsgArry" is an array of character pointers (strings) which describe the command line options. This list of lines will be displayed by the usage function. If func is present it is a pointer to a function returning an integer which will be called before the usage comman exits.

int  Usage( char** msgArry )
Output a usage message to user, displaying a list of command line options, call an optional call-back function to clean up, then exit.    The argunent "cmd" is the ascii command name.    The argument "MsgArry" is an array of character pointers (strings) which describe the command line options.    This list of lines will be displayed by the usage function.    The list must be terminated with a NULL ptr.