FaxOutgoingQueue object

The FaxOutgoingQueue configuration object is used by a fax client application to set and retrieve the configuration parameters on the outbound fax queue on a fax server. The object also includes a method to manage the outbound fax jobs in the job queue. You can also use the FaxOutgoingQueue object to create and access FaxOutgoingJobs collection objects.

Members

The FaxOutgoingQueue object has these types of members:

• Methods
• Properties

Methods

The FaxOutgoingQueue object has these methods.

Method	Description
GetJob	The GetJob method returns an outbound fax job in the job queue according to its ID.
GetJobs	The GetJobs method returns a collection of the outbound fax jobs in the job queue.
Refresh	The Refresh method refreshes FaxOutgoingQueue object information from the fax server. When the Refresh method is called, any configuration changes made after the last Save method call are lost.
Save	The Save method saves the FaxOutgoingQueue object data.

 

Properties

The FaxOutgoingQueue object has these properties.

Property	Access type	Description
AgeLimit	Read/write	The AgeLimit property is a value that indicates the number of days that the fax service retains an unsent job in the fax job queue.
AllowPersonalCoverPages	Read/write	The AllowPersonalCoverPages property is a Boolean value that indicates whether fax client applications can include a user-designed cover page with fax transmissions.
Blocked	Read/write	The Blocked property is a Boolean value that indicates whether the job queue for outgoing faxes is blocked.
Branding	Read/write	The Branding property is a Boolean value that indicates whether the fax service generates a brand (banner) at the top of outgoing fax transmissions. A brand contains transmission-related information, such as the transmitting station identifier, date, time, and page count.
DiscountRateEnd	Read/write	The DiscountRateEnd property is a value that indicates the time at which the discount period for transmitting faxes ends. The discount period applies to outgoing faxes.
DiscountRateStart	Read/write	The DiscountRateStart property is a value that indicates the time at which the discount period for transmitting faxes begins. The discount period applies to outgoing faxes.
Paused	Read/write	The Paused property is a Boolean value that indicates whether the job queue for outgoing faxes is paused.
Retries	Read/write	The Retries property is a value that indicates the number of times that the fax service attempts to retransmit an outgoing fax when the initial transmission fails.
RetryDelay	Read/write	The RetryDelay property is a value that indicates the time interval, in minutes, that the fax service waits before attempting to retransmit an outbound fax job.
UseDeviceTSID	Read/write	The UseDeviceTSID property is a Boolean value that indicates whether the fax service uses the device TSID instead of a sender TSID.

 

Remarks

A FaxOutgoingQueue object is accessed through a FaxFolders object. FaxOutgoingQueue objects provide access to FaxOutgoingJobs objects.

To create a FaxOutgoingQueue object in Microsoft Visual Basic, call the OutgoingQueue property of the FaxFolders object.

To create a FaxOutgoingQueue object in C++, call the OutgoingQueue method.

Note

Changes made to the FaxOutgoingQueue object will not be saved until you call the Save method.

 

Requirements

Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	Faxcomex.h
DLL	Fxscomex.dll
IID	CLSID_FaxOutgoingQueue

See also

Fax Service object hierarchy

IFaxOutgoingQueue