IFaxServer interface (faxcom.h)

Article
07/27/2022

The IFaxServer dual interface is used by a fax client application to manage a connection to the fax service. The interface retrieves and sets information about FaxServer objects; for example, settings for retransmission, branding, archiving and cover pages; discount rate periods; and the status of the fax server queue. The IFaxServer interface includes the following methods:

Methods to initiate and terminate connections with a fax server.
Property methods to retrieve and set individual property values of FaxServer objects.
Methods to create FaxJobs, FaxPorts and FaxDoc objects.

Note A fax client application must call the IFaxServer::Connect method to initiate a connection with an active fax server before accessing most interfaces that begin with IFax. (A fax server connection is not required to access an IFaxTiff interface.)

Inheritance

The IFaxServer interface inherits from the IDispatch interface. IFaxServer also has these types of members:

Methods

The IFaxServer interface has these methods.


IFaxServer::Connect The Connect method connects a fax client application to the specified fax server.
IFaxServer::CreateDocument The IFaxServer::CreateDocument method creates a FaxDoc object for a specified FaxServer object. The FaxDoc object allows a user to create and transmit a document to one or more fax recipients.
IFaxServer::Disconnect The IFaxServer::Disconnect method terminates a fax client application's connection to a fax server.
IFaxServer::get_ArchiveDirectory The IFaxServer::get_ArchiveDirectory method retrieves the ArchiveDirectory property for a FaxServer object. The ArchiveDirectory property is a null-terminated string that contains the location in which the fax server stores archived outbound faxes. (Get)
IFaxServer::get_ArchiveOutboundFaxes Sets or retrieves the ArchiveOutboundFaxes property for a FaxServer object. The ArchiveOutboundFaxes property is a Boolean value that indicates whether the fax server archives outgoing fax transmissions. (Get)
IFaxServer::get_Branding Sets or retrieves the Branding property for a FaxServer object. The Branding property is a Boolean value that indicates whether the fax server generates branding information at the top of fax transmissions. (Get)
IFaxServer::get_DirtyDays Sets or retrieves the DirtyDays property for a FaxServer object. The DirtyDays property is the number of days the fax server retains an unsent job in the fax job queue. (Get)
IFaxServer::get_DiscountRateEndHour Sets or retrieves the DiscountRateEndHour property for a FaxServer object. The DiscountRateEndHour property is a number that represents the hour the discount period ends. The discount period applies only to outgoing fax transmissions. (Get)
IFaxServer::get_DiscountRateEndMinute Sets or retrieves the DiscountRateEndMinute property for a FaxServer object. The DiscountRateEndMinute property is a number that represents the minute the discount period ends. The discount period applies only to outgoing fax transmissions. (Get)
IFaxServer::get_DiscountRateStartHour Sets or retrieves the DiscountRateStartHour property for a FaxServer object. The DiscountRateStartHour property is a number that represents the hour the discount period begins. The discount period applies only to outgoing fax transmissions. (Get)
IFaxServer::get_DiscountRateStartMinute Sets or retrieves the DiscountRateStartMinute property for a FaxServer object. The DiscountRateStartMinute property is a number that represents the minute the discount period begins. The discount period applies only to outgoing fax transmissions. (Get)
IFaxServer::get_PauseServerQueue Sets or retrieves the PauseServerQueue property for a FaxServer object. The PauseServerQueue property is a Boolean value that indicates whether the fax server has paused the fax job queue. (Get)
IFaxServer::get_Retries Sets or retrieves the Retries property for a FaxServer object. The Retries property is a value that represents the number of times the fax server attempts to retransmit an outgoing fax when the initial transmission fails. (Get)
IFaxServer::get_RetryDelay Sets or retrieves the RetryDelay property for a FaxServer object. The RetryDelay property is a value that represents the time interval, in minutes, the fax server waits before attempting to retransmit an outbound fax job. (Get)
IFaxServer::get_ServerCoverpage Sets or retrieves the ServerCoverpage property for a FaxServer object. The ServerCoverpage property is a Boolean value that indicates whether the fax server permits the use of common cover pages only. (Get)
IFaxServer::get_ServerMapiProfile Sets or retrieves the ServerMapiProfile property for a FaxServer object. The ServerMapiProfile property is a null-terminated string that contains the MAPI user profile that the fax server uses for routing incoming fax transmissions. (Get)
IFaxServer::get_UseDeviceTsid Sets or retrieves the UseDeviceTsid property for a FaxServer object. The UseDeviceTsid property is a Boolean value that indicates whether the fax server uses the device's transmitting station identifier (TSID) instead of a user-specified TSID. (Get)
IFaxServer::GetJobs The GetJobs method creates and initializes a FaxJobs object for a specified FaxServer object. The FaxJobs object allows enumeration of the current queued jobs for the connected fax server.
IFaxServer::GetPorts The GetPorts method creates and initializes a FaxPorts object for a specified FaxServer object. The FaxPorts object allows enumeration of fax port configuration information for the connected fax server.
IFaxServer::put_ArchiveDirectory The IFaxServer::get_ArchiveDirectory method retrieves the ArchiveDirectory property for a FaxServer object. The ArchiveDirectory property is a null-terminated string that contains the location in which the fax server stores archived outbound faxes. (Put)
IFaxServer::put_ArchiveOutboundFaxes Sets or retrieves the ArchiveOutboundFaxes property for a FaxServer object. The ArchiveOutboundFaxes property is a Boolean value that indicates whether the fax server archives outgoing fax transmissions. (Put)
IFaxServer::put_Branding Sets or retrieves the Branding property for a FaxServer object. The Branding property is a Boolean value that indicates whether the fax server generates branding information at the top of fax transmissions. (Put)
IFaxServer::put_DirtyDays Sets or retrieves the DirtyDays property for a FaxServer object. The DirtyDays property is the number of days the fax server retains an unsent job in the fax job queue. (Put)
IFaxServer::put_DiscountRateEndHour Sets or retrieves the DiscountRateEndHour property for a FaxServer object. The DiscountRateEndHour property is a number that represents the hour the discount period ends. The discount period applies only to outgoing fax transmissions. (Put)
IFaxServer::put_DiscountRateEndMinute Sets or retrieves the DiscountRateEndMinute property for a FaxServer object. The DiscountRateEndMinute property is a number that represents the minute the discount period ends. The discount period applies only to outgoing fax transmissions. (Put)
IFaxServer::put_DiscountRateStartHour Sets or retrieves the DiscountRateStartHour property for a FaxServer object. The DiscountRateStartHour property is a number that represents the hour the discount period begins. The discount period applies only to outgoing fax transmissions. (Put)
IFaxServer::put_DiscountRateStartMinute Sets or retrieves the DiscountRateStartMinute property for a FaxServer object. The DiscountRateStartMinute property is a number that represents the minute the discount period begins. The discount period applies only to outgoing fax transmissions. (Put)
IFaxServer::put_PauseServerQueue Sets or retrieves the PauseServerQueue property for a FaxServer object. The PauseServerQueue property is a Boolean value that indicates whether the fax server has paused the fax job queue. (Put)
IFaxServer::put_Retries Sets or retrieves the Retries property for a FaxServer object. The Retries property is a value that represents the number of times the fax server attempts to retransmit an outgoing fax when the initial transmission fails. (Put)
IFaxServer::put_RetryDelay Sets or retrieves the RetryDelay property for a FaxServer object. The RetryDelay property is a value that represents the time interval, in minutes, the fax server waits before attempting to retransmit an outbound fax job. (Put)
IFaxServer::put_ServerCoverpage Sets or retrieves the ServerCoverpage property for a FaxServer object. The ServerCoverpage property is a Boolean value that indicates whether the fax server permits the use of common cover pages only. (Put)
IFaxServer::put_ServerMapiProfile Sets or retrieves the ServerMapiProfile property for a FaxServer object. The ServerMapiProfile property is a null-terminated string that contains the MAPI user profile that the fax server uses for routing incoming fax transmissions. (Put)
IFaxServer::put_UseDeviceTsid Sets or retrieves the UseDeviceTsid property for a FaxServer object. The UseDeviceTsid property is a Boolean value that indicates whether the fax server uses the device's transmitting station identifier (TSID) instead of a user-specified TSID. (Put)

Remarks

When to Implement

You should not implement this interface. The Microsoft standard implementation provides complete functionality.

When to Use

Use the IFaxServer interface to connect to and disconnect from an active fax server. Also use the interface to retrieve and set the properties of FaxServer objects, and to create the objects listed in the following steps.

To connect to a fax server, and create other fax client objects, perform the following steps:

Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface and create an instance of a FaxServer object.
Call the IFaxServer::Connect method to initiate a connection with an active fax server.
After you obtain a connection, call the following methods to create the objects you need:
- The IFaxServer::GetJobs method to create a FaxJobs object. Use this object to create FaxJob objects and enumerate the fax jobs associated with a connected fax server.
- The IFaxServer::GetPorts method to create a FaxPorts object. Use this object to create FaxPort objects and enumerate fax port configuration information for a connection to a fax server.
- The IFaxServer::CreateDocument method to create a FaxDoc object. Use this object to transmit a fax and to retrieve and set the properties of FaxDoc objects.
Call the IFaxServer::Disconnect method to disconnect from the fax server.
Call the IUnknown::Release method for each object to allow the object to deallocate itself. Call the method again, if necessary, to destroy the IFaxPorts or the IFaxJobs interface pointers.

Note that a client application should not call the CoCreateInstance function to create FaxJobs, FaxPorts or FaxDoc objects, or objects derived from these objects. For more information about creating and deallocating fax client objects, see the steps that are listed with each individual interface topic and the hierarchical diagram included in The Fax Client Object Model.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	faxcom.h