ATFX_TFPGBASE( )

Description | Example | Errors

Name:	long ATFX_TFPGBASE(dev)
Inputs:	int dev	fax channel device handle
Returns:	base page number scheme for TIFF/F file if successful
	AT_FAILURE if error
Includes:	srllib.h
	dxxxlib.h
	faxlib.h
Category:	extended attribute
Mode:	synchronous

Description

The ATFX_TFPGBASE( ) returns the base page numbering scheme for the most recently transmitted TIFF/F file. Valid values are:

TF_BASE0	First page number is zero (TIFF/F standard)
TF_BASE1	First page number is one

NOTE:

According to TIFF/F requirements, the pages of a multi-page TIFF/F file are numbered internally starting at zero, but some utilities may not adhere strictly to these requirements. See the FC_TFPGBASE parameter in the fx_setparm( ) function reference for more information.

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>  
DF_IOTT iott;  
int dev;  
long tfpgbase;  
/*  
 * Open the channel using fx_open( ) and obtain the Dialogic  
 * FAX device handle in dev.  
 */  
.  
.  
/*  
 * If you are unsure of the page numbering scheme used in  
 * the TIFF/F file to be transmitted, call fx_setparm( ) to  
 * set the FC_TFPGBASE to TF_AUTOPG to enable the auto-  
 * paging mode (determines the page numbering scheme  
 * automatically) (Note: A multi-page TIFF/F file should  
 * have its pages internally numbered starting at zero, but  
 * some utilities may not adhere strictly to TIFF/F  
 * requirements).  
 */  
.  
.  
/*  
 * Call fx_sendfax( ) after setting up the DF_IOTT to  
 * send the TIFF/F file.  
 */  
if (fx_sendfax(dev, &iott, 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 */  
   }  
   .  
   .  
}  
/* Determine page numbering scheme. */  
tfpgbase = ATFX_TFPGBASE(dev);  
/*  
 * Once the page numbering scheme of the TIFF/F file has  
 * been determined, the FC_TFPGBASE parameter may be set  
 * correctly for future transmission of this file (or files)  
 * created by the TIFF utility that was used.  
 */

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