gfqPurgeOne( )

Description | Example

Name:	int gfqPurgeOne (char *gfqFileName, GFQRECORD *qrec);
Inputs:	char *gfqFileName;	Pointer to the name of the Queue File.
	GFQRECORD *qrec	Pointer to the queue record to be purged.
Outputs:	None
Returns:	GFQSUCCESS	The deletion was successful.
	GFQFILE_BUSY	The Queue File is locked by another task.
	GFQFILE_CREATE_ERROR	Unable to create the new 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; that is, being processed by another task.
	GFQRECORD_KEY_ERROR	Key values were changed.
Includes:	gfq.h

Description

The gfqPurgeOne( ) function deletes non-busy records from the Queue File. Before using this function, a queue record must have been successfully read using gfqFindFirst( ) or gfqFindNext( ). Both of these functions determines whether another task has changed the key values of the queue record (linked list, time, or priority). If the key values have been changed, gfqPurgeOne( ) returns the error GFQRECORD_KEY_ERROR. If a queue record is marked BUSY, the function returns the error GFQRECORD_ACTIVE.

Example

#include "gfq.h"  
GFQRECORD qrec;  
char gfqFileName[GFQFILENAME_SIZE];  
int status;  
strcpy (gfqFileName, "c:\\fax\\gfax.$qu");  
if ((status = gfqFindFirst (gfqFileName, &qrec, GFQPEND_LIST, GFQLIST_START,"")) == GFQSUCCESS)  
if (qrec->user_id == "DELETE_ME")  
  return (gfqPurgeOne (gfqFileName, &qrec));

Click here to contact Dialogic Customer Engineering