Fax Service Client API Functions

  • Article

The functions used with the Fax Service Client API fall into the following functional groupings. An alphabetic list follows.

Configuration Management Functions

The Fax Service Client API configuration management functions enable a fax client application to connect to a fax server and communicate with the server using a fax event queue. These functions also provide the application with access to the server's logging categories, global configuration settings, and fax routing method data.

Topic Contents
FaxClose The FaxClose function closes the following types of fax handles:
FaxConnectFaxServer The FaxConnectFaxServer function connects a fax client application to the local fax server. The function returns a fax server handle that is required to call other fax client functions that facilitate job, device, configuration, and document management.
FaxEnumGlobalRoutingInfo The FaxEnumGlobalRoutingInfo function enumerates all fax routing methods associated with a specific fax server. The function returns to the fax client application fax routing method information that applies globally to the server, such as routing priority.
FaxGetConfiguration The FaxGetConfiguration function returns to a fax client application the global configuration settings for the fax server to which the client has connected. The data includes, among other items, retransmission, branding, archive and cover page settings; discount rate periods; and the status of the fax server queue.
FaxGetLoggingCategories The FaxGetLoggingCategories function returns to a fax client application the current logging categories for the fax server to which the client has connected. A logging category determines the errors or other events the fax server records in the application event log.
FaxInitializeEventQueue The FaxInitializeEventQueue function creates a fax event queue for the calling fax client application. The queue enables the application to receive notifications of asynchronous events from the fax server.
FaxSetConfiguration A fax client application calls the FaxSetConfiguration function to change the global configuration settings for the fax server to which the client has connected. The configuration data can include, among other items, retransmission, branding, archive and cover page settings; discount rate periods; and the status of the fax server queue.
FaxSetGlobalRoutingInfo A fax management application calls the FaxSetGlobalRoutingInfo function to modify fax routing method data, such as routing priority, that applies globally to the fax server.
FaxSetLoggingCategories A fax client application calls the FaxSetLoggingCategories function to modify the current logging categories for the fax server to which the client has connected. A logging category determines the errors or other events the fax server records in the application event log.

 

Device Management Functions

The Fax Service Client API device management functions enable a fax administration application to query and administer the configuration of a fax port. These functions also provide access to information about the fax routing methods associated with the port.

Topic Contents
FaxEnableRoutingMethod The FaxEnableRoutingMethod function enables or disables a fax routing method for a specific fax device. A fax administration application typically calls this function for device management.
FaxEnumPorts The FaxEnumPorts function enumerates all fax devices currently attached to the fax server to which the client has connected. The function returns detailed information for each fax port to the fax client application.
FaxEnumRoutingMethods The FaxEnumRoutingMethods function enumerates all fax routing methods for a specific fax device. The function returns information about each routing method to a fax client application.
FaxGetDeviceStatus The FaxGetDeviceStatus function returns to a fax client application current status information for the fax device of interest. The returned data includes, among other items, device and station identifiers, sender and recipient names, and routing information.
FaxGetPort The FaxGetPort function returns information for a specified fax port to a fax client application. The data includes, among other items, the permanent line identifier, the current status and capability of the port, and the transmitting and called station identifiers.
FaxGetRoutingInfo The FaxGetRoutingInfo function returns to a fax client application routing information for a fax routing method that is associated with a specific fax device.
FaxOpenPort The FaxOpenPort function returns a fax port handle to a fax client application. The port handle is required when the application calls other fax client functions that facilitate device management and fax document routing.
FaxSetPort A fax client application calls the FaxSetPort function to change the configuration of the fax port of interest. The configuration data can include, among other items, the capability of the port, its priority, rings before answer, and the transmitting and called station identifiers..
FaxSetRoutingInfo A fax management application calls the FaxSetRoutingInfo function to modify the routing information for a fax routing method that is associated with a specific fax device.

 

Document Management Functions

The Fax Service Client API document management functions enable a fax client application to queue outgoing fax jobs and print fax transmissions. These functions also provide the ability to specify a cover page template file and user information to render onto the template at transmission time.

Topic Contents
FAX_RECIPIENT_CALLBACK The FAX_RECIPIENT_CALLBACK function is an application-defined or library-defined callback function that the FaxSendDocumentForBroadcast function calls to retrieve user-specific information for the transmission.
FaxPrintCoverPage The FaxPrintCoverPage function prints a fax transmission cover page to the specified device context for a fax client application.
FaxSendDocument A fax client application calls the FaxSendDocument function to queue a fax job that will transmit an outgoing fax transmission.
FaxSendDocumentForBroadcast A fax client application calls the FaxSendDocumentForBroadcast function to queue several fax jobs that will transmit the same outgoing fax transmission to several recipients.
FaxStartPrintJob A fax client application calls the FaxStartPrintJob function to start printing an outbound fax transmission on the specified fax printer.

 

Job Management Functions

The Fax Service Client API job management functions provide a fax client application with the ability to query and manage queued and active fax jobs.

Topic Contents
FaxAbort A fax client application calls the FaxAbort function to terminate a fax job.
FaxEnumJobs The FaxEnumJobs function enumerates all queued and active fax jobs on the fax server to which the client has connected. The function returns detailed information for each fax job to the fax client application.
FaxGetJob A fax client application calls the FaxGetJob function to retrieve detailed information for the specified queued or active fax job. The function returns the information in a FAX_JOB_ENTRY structure.
FaxGetPageData The FaxGetPageData function returns to a fax client application the first page of data for a fax job. The fax job must be an outbound job, but it can be queued or active. The function returns data in the Tagged Image File Format Class F (TIFF Class F) format.
FaxSetJob A fax client application calls the FaxSetJob function to pause, resume, cancel, or restart a specified fax job.

 

Fax Utility Functions

The Fax Service Client API utility functions deallocate resources and manipulate data structures. These functions are also useful during the installation of a fax service provider or fax routing extension DLL.

Topic Contents
FaxAccessCheck A fax client application calls the FaxAccessCheck function to query the fax access privileges of a user.
FaxCompleteJobParams The FaxCompleteJobParams function creates both a FAX_COVERPAGE_INFO structure and a FAX_JOB_PARAM structure for a fax client application. This utility function supplies multiple members of these structures with values for the size of the structure, the sender's name, and optional billing code information.
FaxFreeBuffer The FaxFreeBuffer function releases resources associated with a buffer allocated previously as the result of a function call by a fax client application. This includes calls to the FaxCompleteJobParams function and to functions that begin with FaxEnum or FaxGet.
FaxRegisterRoutingExtension The FaxRegisterRoutingExtension function registers a fax routing extension DLL with the fax service. The function configures the fax service registry to use the new routing extension DLL.
FaxRegisterServiceProvider The FaxRegisterServiceProvider function registers a fax service provider DLL with the fax service. The function configures the fax service registry to query and use the new fax service provider DLL when the fax service restarts.
FaxRoutingInstallationCallback The FaxRoutingInstallationCallback function is a library-defined callback function that the FaxRegisterRoutingExtension function calls to install a fax routing extension DLL. FaxRegisterRoutingExtension calls the FaxRoutingInstallationCallback function multiple times, once for each fax routing method the fax routing extension exports.

 

Fax Service Client Functions Alphabetic List

The Fax Service Client API includes the following functions, listed alphabetically.

The Fax Service Client API includes the following callback functions.