fx_loadfont( )

Description | Cautions | Example | Errors | Hints

Name:	int fx_loadfont(chdev, fontfh, mode)
Inputs:	int dev	fax channel device handle
	int fontfh	fax font file handle
	unsigned long mode	mode flag
Returns:	0 if success (on invocation in asynchronous mode)
	-1 if failure (on invocation in asynchronous mode)
Includes:	srllib.h
	dxxxlib.h
	faxlib.h
Category:	miscellaneous
Mode:	synchronous/asynchronous

Description

The fx_loadfont( ) function loads ASCII font to the VFX/40ESCplus board. This function allows an application to change the fonts used by the VFX/40ESCplus for ASCII to fax conversion and for the fax page header.

The VFX/40ESCplus supports the following ASCII font sizes:

• 256 char 20x16 font (font ID #0) - NORMAL
• 256 char 12x12 font (font ID #3) - COMPRESSED (also used to specify the font for the fax page header)

The fax driver determines the font size (font ID #0 or ID #3) from the header in the font file.

NOTE:

Only 20x16 and 12x12 font sizes are supported by the VFX/40ESCplus. Specifying any other font size results in an EFX_INVALID_FONT error.

If the font is successfully loaded on the specified board, the function returns TFX_LOADFONT.

Parameter	Description
chdev	Specifies the first fax device handle for the fax board on which to download a new font. Note that all channels on the fax board are affected.
fontfh	Specifies the fax font file handle.
mode	Specifies the mode of operation.
	EV_SYNC	Synchronous mode (default). When you specify synchronous mode, the function does not return to the application until the fax font load is completed. A zero for success or -1 for failure is returned to the application.
	EV_ASYNC	Asynchronous mode. When you specify asynchronous mode, the fax font load is initiated and control is returned to the application immediately. A return code of zero indicates success and -1 indicates that an error occurred. When the fx_loadfont( ) function completes, one of the following fax events generated by the Standard Runtime Library is returned to your application: TFX_LOADFONT - font successfully loaded TFX_FAXERROR - error

Cautions

• fx_loadfont( ) is operational on the VFX/40ESCplus platform only.

You must issue this function on the first channel of the fax device and it will take effect on all channels of that device.

• All fax channels for the board must be idle before a new font can be loaded, otherwise an EFX_NOTIDLE error is returned from fx_loadfont( ) (or a TFX_FAXERROR event is returned).
• If fx_loadfont( ) is called on a fax product other than the VFX/40ESCplus, the function returns an EFX_UNSUPPORTED error.

Example

#include <windows.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <faxlib.h>  
int dev;             /* Fax channel device handle. */  
int voxdev;          /* Voice channel device handle. */  
int rc;  
int gerc;  
int fontfh;  
main( )  
{  
      /*  
       * Open the channel using dx_open( ) to obtain the Dialogic  
       * voice channel device handle in voxdev.  
       */  
      if ((voxdev = dx_open("dxxxB1C1", NULL)) == -1) {  
         /* Error opening device */  
         /* Perform system error processing */  
         exit(1);  
      }  
      /*  
       * Open the first channel on each board using fx_open( )  
       * to obtain the fax channel device handle in dev.  
       */  
      if ((dev = fx_open("dxxxB1C1", NULL)) == -1) {  
         /* Error opening device */  
         /* Perform system error processing */  
         exit(1);  
      }  
      .  
      .  
      /*  
       * Open font file and call fx_loadfont( ) to  
       * load new font for all channels on this device.  
       */  
      if((fontfh=dx_fileopen("default0.fnt",O_RDONLY | O_BINARY)) == 0) {  
         printf("Error opening default0.fnt \n");  
         /* Error processing. */  
      }  
      if (fx_loadfont(dev, fontfh, EV_SYNC) == -1 ) {  
         printf("Error - %s \n", ATDV_ERRMSGP(dev));  
         /* Error processing. */  
         .  
         .  
      }  
      .  
      .  
      dx_fileclose(fontfh);

Errors

ATDV_LASTERR( ) returns the following fax error codes for the following reasons:

EFX_INVALARG	Invalid argument
EFX_NOTIDLE	Channel not idle
EFX_INVALID_FONT	Invalid font data file
EFX_UNSUPPORTED	Function or sub-function not supported by firmware

For a complete list of fax errors, see Appendix D.

Hints

To determine the fonts currently loaded on a VFX/40ESCplus board or any VFX solution board, use the SCFAXDEM fax demo program to send the fonttest.txt file to a fax machine. The fonts currently loaded on the specified board will print. The SCFAXDEM demo program is installed by default in the samples subdirectory.

Click here to contact Dialogic Customer Engineering