FaxServer object

The FaxServer object is used by a fax client Microsoft Visual Basic application to manage a connection to the fax service. You can also retrieve and set the properties of FaxServer objects, such as settings for retransmission, branding, archiving and cover pages; discount rate periods; and the status of the fax server queue.

The FaxServer object has the following methods and properties:

• Methods to initiate and terminate connections with a fax server.
• Methods to create FaxJobs, FaxPorts, and FaxDoc objects.
• Properties to set and retrieve individual attributes of FaxServer objects.

Use the FaxServer object to connect to and disconnect from an active fax server. After you obtain a connection, you can call the following methods to create other objects you need.

• The 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 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 CreateDocument method to create a FaxDoc object. Use this object to transmit a fax and to retrieve and set the properties of FaxDoc objects.

Note

A fax client application must call the Connect method to initiate a connection with an active fax server before accessing most other objects that begin with Fax. (A fax server connection is not required to access a FaxTiff object.)

 

To create a FaxServer object, call the Visual Basic CreateObject function as illustrated in the following sample:

Dim FaxServer as Object
Set FaxServer = CreateObject("FaxServer.FaxServer")

Members

The FaxServer object has these types of members:

• Methods
• Properties

Methods

The FaxServer object has these methods.

Method	Description
Connect	The Connect method connects a fax client application to the specified fax server. Before accessing most interfaces that begin with IFax, the application must call this method to initiate a connection with an active fax server. A fax server connection is not required to access an IFaxTiff interface.
CreateDocument	The 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.
Disconnect	The Disconnect method terminates a fax client application's connection to a fax server.
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.
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.

 

Properties

The FaxServer object has these properties.

Property	Access type	Description
ArchiveDirectory	Read/write	The 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.
ArchiveOutboundFaxes	Read/write	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.
Branding	Read/write	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.
DirtyDays	Read/write	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.
DiscountRateEndHour	Read/write	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.
DiscountRateEndMinute	Read/write	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.
DiscountRateStartHour	Read/write	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.
DiscountRateStartMinute	Read/write	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.
PauseServerQueue	Read/write	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.
Retries	Read/write	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.
RetryDelay	Read/write	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.
ServerCoverpage	Read/write	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.
ServerMapiProfile	Read/write	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.
UseDeviceTsid	Read/write	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 TSID instead of a user-specified TSID.

 

Remarks

When to Implement

You should not implement this class. The Microsoft standard implementation provides complete functionality. You can use the Visual Basic Object Browser to view the FaxServer object's type library information in Visual Basic syntax.