Legacy API

Deprecated prior version of the CLP functionality. More...

Macros
#define	MAX_LENGTH_FILE_NAME   255

Functions
int	osfiCLP (int argc, char *argv[])
void	osfiCLPGetConfFile (char *fileName, int *length)
void	osfiCLPGetConfFiles (char *confFiles[], int *noFiles)
void	osfiCLPGetInputFiles (char *inputFiles[], int *noFiles)
void	osfiCLPGetOutputFiles (char *outputFiles[], int *noFiles)

Detailed Description

Deprecated prior version of the CLP functionality.

Deprecated:

The prior version of the CLP API has been deprecated for both safety and usability concerns. All users should switch to the new API, which does not require callers to preallocate the buffers in which the parsed paths will be stored.

Warning

This API is deprecated and will be removed in a future version.

Macro Definition Documentation

MAX_LENGTH_FILE_NAME

#define MAX_LENGTH_FILE_NAME   255

The old CLP API expects the user-provided destination buffers for file names to be allocated with at least this size plus one (for the final \0).

Function Documentation

osfiCLP()

int osfiCLP	(	int	argc,
		char *	argv[]
	)

CLP Initializer. Needs the command line arguments.

Parameters

argc	- number of arguments
argv	- list of array of characters

Returns

FALSE (zero) in case of error, nonzero otherwise

See also

osfiCommonClose()

Deprecated:

Use osfiClpParseArgs() instead

osfiCLPGetConfFile()

void osfiCLPGetConfFile	(	char *	fileName,
		int *	length
	)

Gets the name of the configuration file. Configuration file can be "" if no configuration file is passed.

Parameters

fileName	pointer to a user-allocated buffer of size MAX_LENGTH_FILE_NAME+1.
length	pointer to an integer where the file name length will be stored.

Deprecated:

Modules with a single configuration file are deprecated

osfiCLPGetConfFiles()

void osfiCLPGetConfFiles	(	char *	confFiles[],
		int *	noFiles
	)

Gets the list of configuration files.

Parameters

confFiles	pointer to a user-allocated array of sufficient size for the expected arguments, where each entry points to a user-allocated string buffer of size MAX_LENGTH_FILE_NAME+1.
noFiles	pointer to an integer where the number of files will be stored.

Deprecated:

Use osfiClpParseArgs() instead

osfiCLPGetInputFiles()

void osfiCLPGetInputFiles	(	char *	inputFiles[],
		int *	noFiles
	)

Gets the list of input files.

Parameters

inputFiles	pointer to a user-allocated array of sufficient size for the expected inputs, where each entry points to a user-allocated string buffer of size MAX_LENGTH_FILE_NAME+1.
noFiles	pointer to an integer where the number of files will be stored.

Deprecated:

Use osfiClpParseArgs() instead

osfiCLPGetOutputFiles()

void osfiCLPGetOutputFiles	(	char *	outputFiles[],
		int *	noFiles
	)

Gets the list of output files.

Parameters

outputFiles	pointer to a user-allocated array of sufficient size for the expected outputs, where each entry points to a user-allocated string buffer of size MAX_LENGTH_FILE_NAME+1.
noFiles	pointer to an integer where the number of files will be stored.

Deprecated:

Use osfiClpParseArgs() instead