| Platform SDK: Fax Services |
The functions used with the Fax Service Client API fall into the following functional groupings. An alphabetic list follows.
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.
| Function | Description |
|---|---|
| FaxClose | Closes a fax server handle returned by a call to the FaxConnectFaxServer function or a fax port handle returned by a call to the FaxOpenPort function. |
| FaxConnectFaxServer | Connects a fax client application to a fax server and returns a fax server handle that is required to call other fax client functions. |
| FaxEnumGlobalRoutingInfo | Enumerates all fax routing methods associated with a specific fax server. |
| FaxGetConfiguration | Retrieves global configuration settings for a fax server. The data includes retransmission, branding, archive, and cover page settings; discount rate periods; and the status of the fax server queue. |
| FaxGetLoggingCategories | Retrieves the current logging categories for a fax server. The logging category determines the type of errors or other events the fax server logs in the application event log. |
| FaxInitializeEventQueue | Creates a fax event queue that enables an application to receive notifications of asynchronous events from the fax server. The application can request I/O completion packets or notification messages. |
| FaxSetConfiguration | Modifies the global configuration settings for a fax server. |
| FaxSetGlobalRoutingInfo | Modifies routing method data that applies globally to a fax server, such as routing priority. |
| FaxSetLoggingCategories | Modifies the current logging categories for a fax server. |
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.
| Function | Description |
|---|---|
| FaxEnableRoutingMethod | Enables or disables a fax routing method for a specific fax device. |
| FaxEnumPorts | Enumerates all fax devices currently attached to a fax server. |
| FaxEnumRoutingMethods | Enumerates all fax routing methods for a specific fax device. |
| FaxGetDeviceStatus | Retrieves the current status information for a fax device, as well as device and station identifiers, sender and recipient names, and routing information. |
| FaxGetPort | Retrieves configuration information for a fax port, such as the permanent line identifier, and the current status and capability of the port. |
| FaxGetRoutingInfo | Retrieves the routing information for a fax routing method associated with a specific fax device. |
| FaxOpenPort | Returns a fax port handle that is required to call other fax client functions that facilitate device management and fax document routing. |
| FaxSetPort | Modifies the configuration of a fax port. |
| FaxSetRoutingInfo | Modifies the routing information for a fax routing method associated with a specific fax device. |
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.
| Function | Description |
|---|---|
| FAX_RECIPIENT_CALLBACK | Retrieves user-specific information for a fax transmission. |
| FaxPrintCoverPage | Prints a cover page for an outbound fax transmission. The cover page can be a personal cover page stored on a local computer, or it can be a common cover page stored on a fax server. |
| FaxSendDocument | Queues a fax job that will transmit a specified document as an outgoing fax transmission. |
| FaxSendDocumentForBroadcast | Queues several fax jobs that will transmit the same document to several recipients. The FaxSendDocumentForBroadcast function calls FAX_RECIPIENT_CALLBACK once for each designated fax recipient. |
| FaxStartPrintJob | Prints an outbound fax transmission on a specified fax printer, and returns a handle to a printer device context that is required to call the FaxPrintCoverPage function. |
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.
| Function | Description |
|---|---|
| FaxAbort | Terminates a fax job that is in progress. |
| FaxEnumJobs | Enumerates all queued and active fax jobs on a fax server. |
| FaxGetJob | Retrieves detailed information for a queued or an active fax job. |
| FaxGetPageData | Returns the first page of data for a queued outbound fax job. |
| FaxSetJob | Pauses, resumes, cancels, or restarts a fax job. |
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 dynamic-link library (DLL).
| Function | Description |
|---|---|
| FAX_ROUTING_INSTALLATION_ CALLBACK |
Installs a fax routing extension DLL. The FaxRegisterRoutingExtension function calls FAX_ROUTING_INSTALLATION_CALLBACK once for each fax routing method the fax routing extension exports. |
| FaxAccessCheck | Queries the fax access privileges of a user. |
| FaxCompleteJobParams | Creates a FAX_COVERPAGE_INFO structure and a FAX_JOB_PARAM structure, and supplies members of these structures with values. |
| FaxFreeBuffer | Releases resources 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 | Registers a fax routing extension DLL with the fax service. |
| FaxRegisterServiceProvider | Registers a fax service provider DLL with the fax service. |
The Fax Service Client API includes the following functions, listed alphabetically:
FaxAbort
FaxAccessCheck
FaxClose
FaxCompleteJobParams
FaxConnectFaxServer
FaxEnableRoutingMethod
FaxEnumGlobalRoutingInfo
FaxEnumJobs
FaxEnumPorts
FaxEnumRoutingMethods
FaxFreeBuffer
FaxGetConfiguration
FaxGetDeviceStatus
FaxGetJob
FaxGetLoggingCategories
FaxGetPageData
FaxGetPort
FaxGetRoutingInfo
FaxInitializeEventQueue
FaxOpenPort
FaxPrintCoverPage
FaxRegisterRoutingExtension
FaxRegisterServiceProvider
FaxSendDocument
FaxSendDocumentForBroadcast
FaxSetConfiguration
FaxSetGlobalRoutingInfo
FaxSetJob
FaxSetLoggingCategories
FaxSetPort
FaxSetRoutingInfo
FaxStartPrintJob
The Fax Service Client API includes the following callback functions: