winfax.h header
This header is used by Fax Service. For more information, see:
winfax.h contains the following programming interfaces:
Functions
| FaxCompleteJobParamsA The FaxCompleteJobParams function creates both a FAX_COVERPAGE_INFO structure and a FAX_JOB_PARAM structure for a fax client application. (ANSI) |
| FaxCompleteJobParamsW The FaxCompleteJobParams function creates both a FAX_COVERPAGE_INFO structure and a FAX_JOB_PARAM structure for a fax client application. (Unicode) |
| FaxConnectFaxServerA 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. (ANSI) |
| FaxConnectFaxServerW 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. (Unicode) |
| FaxEnableRoutingMethodA 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. (ANSI) |
| FaxEnableRoutingMethodW 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. (Unicode) |
| FaxEnumGlobalRoutingInfoA The FaxEnumGlobalRoutingInfo function enumerates all fax routing methods associated with a specific fax server. (ANSI) |
| FaxEnumGlobalRoutingInfoW The FaxEnumGlobalRoutingInfo function enumerates all fax routing methods associated with a specific fax server. (Unicode) |
| FaxEnumJobsA 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. (ANSI) |
| FaxEnumJobsW 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. (Unicode) |
| FaxEnumPortsA 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. (ANSI) |
| FaxEnumPortsW 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. (Unicode) |
| FaxEnumRoutingMethodsA 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. (ANSI) |
| FaxEnumRoutingMethodsW 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. (Unicode) |
| FaxGetConfigurationA The FaxGetConfiguration function returns to a fax client application the global configuration settings for the fax server to which the client has connected. (ANSI) |
| FaxGetConfigurationW The FaxGetConfiguration function returns to a fax client application the global configuration settings for the fax server to which the client has connected. (Unicode) |
| FaxGetDeviceStatusA The FaxGetDeviceStatus function returns to a fax client application current status information for the fax device of interest. (ANSI) |
| FaxGetDeviceStatusW The FaxGetDeviceStatus function returns to a fax client application current status information for the fax device of interest. (Unicode) |
| FaxGetJobA 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. (ANSI) |
| FaxGetJobW 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. (Unicode) |
| FaxGetLoggingCategoriesA The FaxGetLoggingCategories function returns to a fax client application the current logging categories for the fax server to which the client has connected. (ANSI) |
| FaxGetLoggingCategoriesW The FaxGetLoggingCategories function returns to a fax client application the current logging categories for the fax server to which the client has connected. (Unicode) |
| FaxGetPortA The FaxGetPort function returns information for a specified fax port to a fax client application. (ANSI) |
| FaxGetPortW The FaxGetPort function returns information for a specified fax port to a fax client application. (Unicode) |
| FaxGetRoutingInfoA The FaxGetRoutingInfo function returns to a fax client application routing information for a fax routing method that is associated with a specific fax device. (ANSI) |
| FaxGetRoutingInfoW The FaxGetRoutingInfo function returns to a fax client application routing information for a fax routing method that is associated with a specific fax device. (Unicode) |
| FaxPrintCoverPageA The FaxPrintCoverPage function prints a fax transmission cover page to the specified device context for a fax client application. (ANSI) |
| FaxPrintCoverPageW The FaxPrintCoverPage function prints a fax transmission cover page to the specified device context for a fax client application. (Unicode) |
| FaxRegisterRoutingExtensionW 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. |
| FaxRegisterServiceProviderW 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. |
| FaxSendDocumentA A fax client application calls the FaxSendDocument function to queue a fax job that will transmit an outgoing fax transmission. (ANSI) |
| FaxSendDocumentForBroadcastA A fax client application calls the FaxSendDocumentForBroadcast function to queue several fax jobs that will transmit the same outgoing fax transmission to several recipients. (ANSI) |
| FaxSendDocumentForBroadcastW A fax client application calls the FaxSendDocumentForBroadcast function to queue several fax jobs that will transmit the same outgoing fax transmission to several recipients. (Unicode) |
| FaxSendDocumentW A fax client application calls the FaxSendDocument function to queue a fax job that will transmit an outgoing fax transmission. (Unicode) |
| FaxSetConfigurationA A fax client application calls the FaxSetConfiguration function to change the global configuration settings for the fax server to which the client has connected. (ANSI) |
| FaxSetConfigurationW A fax client application calls the FaxSetConfiguration function to change the global configuration settings for the fax server to which the client has connected. (Unicode) |
| FaxSetGlobalRoutingInfoA 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. (ANSI) |
| FaxSetGlobalRoutingInfoW 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. (Unicode) |
| FaxSetJobA A fax client application calls the FaxSetJob function to pause, resume, cancel, or restart a specified fax job. (ANSI) |
| FaxSetJobW A fax client application calls the FaxSetJob function to pause, resume, cancel, or restart a specified fax job. (Unicode) |
| FaxSetLoggingCategoriesA A fax client application calls the FaxSetLoggingCategories function to modify the current logging categories for the fax server to which the client has connected. (ANSI) |
| FaxSetLoggingCategoriesW A fax client application calls the FaxSetLoggingCategories function to modify the current logging categories for the fax server to which the client has connected. (Unicode) |
| FaxSetPortA A fax client application calls the FaxSetPort function to change the configuration of the fax port of interest. (ANSI) |
| FaxSetPortW A fax client application calls the FaxSetPort function to change the configuration of the fax port of interest. (Unicode) |
| FaxSetRoutingInfoA 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. (ANSI) |
| FaxSetRoutingInfoW 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. (Unicode) |
| FaxStartPrintJobA A fax client application calls the FaxStartPrintJob function to start printing an outbound fax transmission on the specified fax printer. (ANSI) |
| FaxStartPrintJobW A fax client application calls the FaxStartPrintJob function to start printing an outbound fax transmission on the specified fax printer. (Unicode) |
Callback functions
| PFAX_RECIPIENT_CALLBACKA 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. (ANSI) |
| PFAX_RECIPIENT_CALLBACKW 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. (Unicode) |
| PFAX_ROUTING_INSTALLATION_CALLBACKW The FaxRoutingInstallationCallback function is a library-defined callback function that the FaxRegisterRoutingExtension function calls to install a fax routing extension DLL. |
| PFAXABORT A fax client application calls the FaxAbort function to terminate a fax job. |
| PFAXACCESSCHECK A fax client application calls the FaxAccessCheck function to query the fax access privileges of a user. |
| PFAXCLOSE The FaxClose function closes fax handles |
| PFAXFREEBUFFER The FaxFreeBuffer function releases resources associated with a buffer allocated previously as the result of a function call by a fax client application. |
| PFAXGETPAGEDATA The FaxGetPageData function returns to a fax client application the first page of data for a fax job. |
| PFAXINITIALIZEEVENTQUEUE 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. |
| PFAXOPENPORT 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. |
Structures
| FAX_CONFIGURATIONA The FAX_CONFIGURATION structure contains information about the global configuration settings of a fax server. (ANSI) |
| FAX_CONFIGURATIONW The FAX_CONFIGURATION structure contains information about the global configuration settings of a fax server. (Unicode) |
| FAX_CONTEXT_INFOA The FAX_CONTEXT_INFO structure contains information about a fax printer device context. The SizeOfStruct member is required. Information for the other members is supplied by a call to the FaxStartPrintJob function. (ANSI) |
| FAX_CONTEXT_INFOW The FAX_CONTEXT_INFO structure contains information about a fax printer device context. The SizeOfStruct member is required. Information for the other members is supplied by a call to the FaxStartPrintJob function. (Unicode) |
| FAX_COVERPAGE_INFOA The FAX_COVERPAGE_INFO structure contains data to display on the cover page of a fax transmission. The SizeOfStruct and CoverPageName members are required; other members are optional. (ANSI) |
| FAX_COVERPAGE_INFOW The FAX_COVERPAGE_INFO structure contains data to display on the cover page of a fax transmission. The SizeOfStruct and CoverPageName members are required; other members are optional. (Unicode) |
| FAX_DEVICE_STATUSA The FAX_DEVICE_STATUS structure contains information about the current status of a fax device. (ANSI) |
| FAX_DEVICE_STATUSW The FAX_DEVICE_STATUS structure contains information about the current status of a fax device. (Unicode) |
| FAX_EVENTA The FAX_EVENT structure represents the contents of an I/O completion packet. The fax server sends the completion packet to notify a fax client application of an asynchronous fax server event. (ANSI) |
| FAX_EVENTW The FAX_EVENT structure represents the contents of an I/O completion packet. The fax server sends the completion packet to notify a fax client application of an asynchronous fax server event. (Unicode) |
| FAX_GLOBAL_ROUTING_INFOA The FAX_GLOBAL_ROUTING_INFO structure contains information about one fax routing method, as it pertains globally to the fax service. (ANSI) |
| FAX_GLOBAL_ROUTING_INFOW The FAX_GLOBAL_ROUTING_INFO structure contains information about one fax routing method, as it pertains globally to the fax service. (Unicode) |
| FAX_JOB_ENTRYA The FAX_JOB_ENTRY structure describes one fax job. (ANSI) |
| FAX_JOB_ENTRYW The FAX_JOB_ENTRY structure describes one fax job. (Unicode) |
| FAX_JOB_PARAMA The FAX_JOB_PARAM structure contains the information necessary for the fax server to send an individual fax transmission. (ANSI) |
| FAX_JOB_PARAMW The FAX_JOB_PARAM structure contains the information necessary for the fax server to send an individual fax transmission. (Unicode) |
| FAX_LOG_CATEGORYA The FAX_LOG_CATEGORY structure describes one logging category. (ANSI) |
| FAX_LOG_CATEGORYW The FAX_LOG_CATEGORY structure describes one logging category. (Unicode) |
| FAX_PORT_INFOA The FAX_PORT_INFO structure describes one fax port. The data includes, among other items, a device identifier, the port's name and current status, and station identifiers. (ANSI) |
| FAX_PORT_INFOW The FAX_PORT_INFO structure describes one fax port. The data includes, among other items, a device identifier, the port's name and current status, and station identifiers. (Unicode) |
| FAX_PRINT_INFOA The FAX_PRINT_INFO structure contains the information necessary for the fax server to print a fax transmission. The structure includes sender and recipient data, an optional billing code, and delivery report information. (ANSI) |
| FAX_PRINT_INFOW The FAX_PRINT_INFO structure contains the information necessary for the fax server to print a fax transmission. The structure includes sender and recipient data, an optional billing code, and delivery report information. (Unicode) |
| FAX_ROUTING_METHODA The FAX_ROUTING_METHOD structure contains information about one fax routing method, as it pertains to one fax device. (ANSI) |
| FAX_ROUTING_METHODW The FAX_ROUTING_METHOD structure contains information about one fax routing method, as it pertains to one fax device. (Unicode) |
| FAX_TIME The FAX_TIME structure represents a time, using individual members for the current hour and minute. The time is expressed in Coordinated Universal Time (UTC). |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for