gfqPurgeAll( )

Description | Example

Name:	int gfqPurgeAll (char *gfqFileName, GFQRECORD *qrec, int list, char *user);
Inputs:	char *gfqFileName	A pointer to the name of the Queue File.
	GFQRECORD *qrec	A pointer to the queue record.
	int list	A linked list in the Queue File.
	char *user	A pointer to a user's identification.
Outputs:	None
Returns:	GFQSUCCESS	The purge was executed.
	GFQFILE_BUSY	The Queue File is locked by another task.
	GFQFILE_CREATE_ERROR	Unable to create the Queue File.
	GFQFILE_INCOMPATIBLE	The Queue File version is incompatible with this version of the GDK software.
	GFQFILE_NOTFOUND	The Queue File was not found.
	GFQFILE_OPEN_ERROR	Unable to open the Queue File.
	GFQRECORD_ACTIVE	The record is active; i.e., being processed by another task.
	GFQLIST_NOTFOUND	The list is not a valid Queue File List.
Includes:	gfq.h

Description

The gfqPurgeAll( ) function purges from one of the Queue Files lists all records for a specific user that are not active or BUSY. If the user is NULL or "", all records on the list that are not busy are purged. If the purge succeeds, the function returns GFQSUCCESS, even when the list had no records.

To make disk space available, gfqPurgeAll( ) also automatically shrinks the Queue File to its minimum size of 78 bytes, leaving only the Queue File header, but under two conditions:

• Automatic shrinking has been allowed. When using the GFQRESET program, automatic shrinking can be enabled with the -r0 option after preallocating records for the Queue File.
• None of the linked lists contain records.

Example

#include "gfq.h"  
#include "gfqpath.h"  
GFQRECORD qrec;  
char queuefile[128] = "\0";  
int status;  
/* get fully qualified path to queue file */  
if (gfqGetPath(GFQDIR_QUEUE, "gfax.$qu", queuefile) != GFQSUCCESS)  
{  
  fprintf(stderr, "GFAX environment variable not defined\n");  
  exit(1);  
}  
status = gfqPurgeAll(queuefile, &qrec, GFQSENT_LIST, Delete_Me");  
if (status != GFQSUCCESS)  
{  
  printf("gfqPurgeAll Sending List failed, %d\n", status);  
  myErrorRoutine(status);  
}  
else  
  printf("All 'Delete_Me' records purged from Sending List\n");

Click here to contact Dialogic Customer Engineering