gfqSearch( )

Description | Example

Name:	int gfqSearch (int ft, char *fn, char *fullfn);
Inputs:	int ft	Select the file type (symbolic constant) listed in Table 27.
	char *fn	The name of a user-specific file, such as "GFAX.$QU" or test001.tif.
Outputs:	char *fullfn	A fully qualified filename of an existing file is returned only if the function is successful. A null string is returned if the function is not successful.
Returns:	GFQSUCCESS	The function completed successfully; the "path" points to the desired file, and it does exist.
	GFQPATH_NOT_SET	The file could not be found because the environment information was not present. This is a fatal error.
	GFQPATH_INVALID	The file could not be found because the environment information was in error. This is a fatal error.
	GFQPATH_NO_FILE	The file could not be found, but the environment information seemed correct. No filename is returned.
	GFQPATH_BAD_TYPE	The file type specified was invalid.
Includes:	gfq.h
	gfqpath.h

Description

The gfqSearch( ) function returns a fully qualified filename. It verifies that a file of the given name and type does exist. It is used to locate existing GDK files, such as the Queue File and configuration files.

The environment variables for gfqSearch( ) are listed in
Table 31. The symbolic constants used in this function are in the gfqpath.h file.

Table 31. Environment Variables for gfqSearch( )

Symbolic Constant	Initial Search Target	Second Target	Meaning
GFQDIR_QUEUE	GFAXQ	GFAX	Locate the Queue File.
GFQDIR_UTILITY	GFAXU	GFAX	Locate the utility programs.
GFQDIR_SEND	GFAXS	current directory	Locate the send files.
GFQDIR_RECEIVE	GFAXR	current directory	Locate the received files.
GFQDIR_LOG	GFAXL	GFAX	Locate the log files.
GFQDIR_CONFIG	GFAXC	GFAX	Locate the configuration files.

Example

#include "gfq.h"  
#include "gfqpath.h"  
char path[64];  
if ((status = gfqSearch (GFQDIR_QUEUE, "gfax.$qu", path)) == GFQSUCCESS)  
{  
  printf ("Queue file path is %s\n", path);  
}  
else  
{  
  printf ("gfqSearch failed, status = %d\n", status);  
}

Click here to contact Dialogic Customer Engineering