fx_close( )

Description | Cautions | Example | Errors | See Also

Name:	int fx_close(dev)
Inputs:	int dev	fax channel device handle
Returns:	0 if successful
	-1 if error
Includes:	srllib.h
	dxxxlib.h
	faxlib.h
Category:	resource management
Mode:	synchronous

Description

The fx_close( ) function closes a Dialogic fax channel device opened previously using fx_open( ). It releases the handle and breaks any link the calling process has with the fax device channel through this handle, regardless of whether the device is busy or idle.

NOTE:

fx_close( ) disables the generation of all fax events; it does not affect the hookstate or parameter settings for the voice channel device.

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

Cautions

• Once a fax channel device is closed, a process can no longer perform an action on this fax channel device using this device handle. Other handles for this channel device that exist in the same process or in other processes are still valid. The only process affected by fx_close( ) is the process that called the function.
• fx_close( ) does not affect any action occurring on a fax channel device; it only breaks the link between the calling process and the fax channel device by freeing the specified fax channel device handle. Other links through different device handles are still valid.
• Do not use the Windows close( ) function to close a fax channel device. Unpredictable results will occur.
• fx_close( ) discards any outstanding fax events on the fax handle.

Example

#include <windows.h>  
#include <srllib.h>  
#include <dxxxlib.h>  
#include <faxlib.h>  
main( )  
{  
   int dev;    /* Fax channel device handle. */  
/* Open the Voice channel device using dx_open( ). */  
.  
.  
/* Open the FAX channel device. */  
   if ((dev = fx_open("dxxxB1C1", NULL)) == -1) {  
      /* Error opening device */  
      /* Perform system error processing */  
      exit(1);  
   }  
   /* FAX transfers (send/receive) calling FAX API functions using dev. */  
   .  
   .  
/* Close the FAX channel device. */  
   if (fx_close(dev) == -1) {  
      /* Error closing device. */  
      printf("Error closing channel\n");  
       printf("Error - %s (error code %d)\n",  
         ATDV_ERRMSGP(dev), ATDV_LASTERR(dev));  
      if (ATDV_LASTERR(dev) == EDX_SYSTEM) {  
         /* Perform system error processing */  
      }  
      exit(1);  
   }  
   .  
   .  
}

Errors

If this function returns -1 to indicate failure, a system error has occurred; use dx_fileerrno( ) to obtain the system error value. Refer to the dx_fileerrno( ) function in the Voice Software Reference - Programmer's Guide for a list of the possible system error values.

See Also

• fx_open( )

Click here to contact Dialogic Customer Engineering