ATFX_PGXFER( )

Description | Example | Errors

Name:	long ATFX_PGXFER(dev)
Inputs:	int dev	fax channel device handle
Returns:	number of pages transferred if successful
	AT_FAILURE if error
Includes:	srllib.h
	dxxxlib.h
	faxlib.h
Category:	extended attribute
Mode:	synchronous

Description

The ATFX_PGXFER( ) function returns the number of transferred fax pages during the current fax call.

This function typically indicates the number of pages transferred by the fx_rcvfax( ), fx_rcvfax2( ) or fx_sendfax( ) function. You can issue ATFX_PGXFER( ) any time during a fax transfer to return the cumulative page count for the fax session.

The final page count value returned by ATFX_PGXFER( ) at the end of a fax session remains available to the application until a new send or receive is initiated on that channel.

NOTE:

In turnaround polling, this function provides a cumulative page count to include both sending and receiving on the specified channel.

Parameter	Description
dev	Specifies the channel device handle for the fax channel obtained when the channel was opened.

Example

#include <stdio.h>  
#include <windows.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <faxlib.h>  
int dev;  
/*  
 * Open the channel using fx_open( ) and obtain the Dialogic  
 * FAX device handle in dev.  
 */  
.  
.  
/*  
 * Call fx_rcvfax( ) to receive a fax into the file  
 * "myfax.tif".  
 */  
if (fx_rcvfax(dev, "myfax.tif", DF_TIFF|DF_NOPOLL|EV_SYNC)  
   == -1) {  
   printf("Error - %s (error code %d)\n",  
      ATDV_ERRMSGP(dev),ATDV_LASTERR(dev));  
   if (ATDV_LASTERR(dev)==EDX_SYSTEM) {  
      /* Perform system error processing */  
   }  
   /*  
    * Additional error processing - check Phase E status to  
    * determine cause of error during fax protocol.  
    */  
   printf("Phase E status: %ld\n", ATFX_ESTAT(dev));  
   .  
   .  
}  
printf("Number of pages received: %ld\n", ATFX_PGXFER(dev));

Errors

This function fails and returns AT_FAILURE if an invalid fax channel device handle is specified in dev.

Click here to contact Dialogic Customer Engineering