ATFX_SCANLINES( )

Description | Example | Errors

Name:	long ATFX_SCANLINES(dev)
Inputs:	int dev	fax channel device handle
Returns:	total number of scan lines in last page transferred if successful
	AT_FAILURE if error
Includes:	srllib.h
	dxxxlib.h
	faxlib.h
Category:	extended attribute
Mode:	synchronous

Description

The ATFX_SCANLINES( ) function returns the number of scan lines in the last page transmitted or received. This information is available at the end of Phase D for every page sent or received.

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

The data provided by this function is updated each time the fax transfer completes Phase D of the T.30 protocol.

To monitor the number of scan lines, you must enable Phase D events and issue ATFX_SCANLINES( ) when the TFX_PHASED event occurs. Note that since Phase D also occurs at the end of a send or receive when a Phase D event is not generated, you can issue this function after a TFX_FAXSEND or TFX_FAXRECV event.

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

NOTE:

Between multiple Phase D completions during the same fax session, ATFX_SCANLINES( ) returns the total number of scan lines from the previously completed page.

Example

#include <stdio.h>  
#include <windows.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <faxlib.h>  
int dev;  
/* Handler for Phase D events. */  
int phd_hdlr( );  
main( )  
{  
   /*  
    * Open the channel using fx_open( ) and obtain the Dialogic  
    * FAX device handle in dev.  
    */  
   .  
   .  
   /*  
    * Install handler to service TFX_PHASED events.  
    */  
    if (sr_enbhdlr(dev, TFX_PHASED, phd_hdlr) == -1) {  
        printf("Failed to install Phase D handler \n");  
        return;  
}  
   
   /*  
    * Call fx_rcvfax( ) in asynchronous mode to receive  
    * TIFF/F file. Set DF_PHASED bit in mode field  
    * to enable generation of Phase D events.  
    */  
   if (fx_rcvfax(dev,"fax.tif", EV_ASYNC|DF_PHASED) == -1) {  
      printf("Error - %s (error code %d)\n",  
         ATDV_ERRMSGP(dev),ATDV_LASTERR(dev));  
      if (ATDV_LASTERR(dev)==EDX_SYSTEM) {  
         /* Perform system error processing */  
      }  
   }  
   .  
   .  
/*  
 * Handler registered with SRL to handle TFX_PHASED events.  
 */  
int phd_hdlr( )  
{  
   int dev = sr_getevtdev( );  
   /*  
    * Total number of scan lines on the page just  
    * received is available at this point.  
    */  
      printf("Total number of scan lines in page received: %ld\n",  
         ATFX_SCANLINES(dev));  
   .  
   .  
   return(0);  
}

Errors

If one of the following conditions is present, this function fails and returns AT_FAILURE:

• An invalid fax channel device handle is specified in dev.
• The function is called prior to the completion of the first Phase D event.

Click here to contact Dialogic Customer Engineering