gfqInsertPlist( )

Description | Example

Name:	int gfqInsertPlist (GFQCHAR *gfqFileName, GFQRECORD *qrec, int list, GFQCHAR *phonelist);
Inputs:	GFQCHAR *gfqFileName	A pointer to the name of the Queue File.
	GFQRECORD *qrec	A pointer to a queue record.
	int list	The specified linked list of the Queue File.
	GFQCHAR *phonelist	A pointer to the name of the file containing the list of phone numbers.
Outputs:	None
Returns:	GFQSUCCESS	The record(s) were inserted.
	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.
	RECORD_WRITE_ERROR	Unable to create a new queue record.
	GFQPHONE_FILE_ERROR	The phone-list file could not be opened.
Includes:	gfq.h

Description

The gfqInsertPlist( ) function inserts one record into a list for every phone number in the phone list. It writes a queue record for each entry in the phone list into the specified list of the Queue File. The phone-list file is automatically opened, processed, and closed.

The structure of a record inside a phone list is shown below, and followed by the maximum length of each field:

Table 29. gfqInsertPlist Phone Number Record Structure

Field	Maximum Length
phone_number	20
rate	4
cd_timeout	4
last_name	20
first_name	12
company	20
category	10
class	10
voice	20

Each field must be delimited by a space. Each line in the file is a record and must be separated by a control line feed (CR LF).

The minimum requirement for a valid phone-list record is the phone_no field. If the rate and cd_timeout are missing, the values from the queue record are taken. If the rate specified in the queue record is different from the phone-list record, the lower of the two values is used. If the phone list is not specified
(NULL or ""), gfqInsertPlist( ) calls gfqInsertOne( ).

Table 30 lists the names used with gfqInsertPlist( ).

The user is responsible for verifying the following:

• A phone-list file exists, and that it was correctly created.
• Fields of the queue record, such as cd_timeout and trans_rate, are set to their defaults.

Table 30. List Names Used with gfqInsertPlist( )

Mnemonic	Meaning
GFQPEND_LIST	Pending List
GFQRECV_LIST	Received List
GFQSENT_LIST	Sent List
GFQCONV_LIST	Conversion List
GFQCTRL_LIST	Control List
GFQCPST_LIST	Control Done List

Example

#include "gfq.h"  
#include "gfqpath.h"  
GFQRECORD qrec;  
char queuefile[128] = "\0";  
char phonelist[128] =  

"c:\\broadcst\\phonelst.txt";  
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);  
}  
/* initialize and fill in queue record */  
...  
status = gfqInsertPlist(queuefile, &qrec, GFQPEND_LIST, phonelist);  
if (status != GFQSUCCESS)  
{  
    printf("gfqInsertPlist failed, %d\n", status);  
    myErrorRoutine(status);  
}  
else  
    printf("Fax broadcast successfully submitted to Pending List\n");

Click here to contact Dialogic Customer Engineering