FaxJob object

The FaxJob object permits a fax client Microsoft Visual Basic application to access the job status for incoming and outgoing fax transmissions, and to pause, resume, cancel or restart a fax job. You can also use the object to retrieve information about fax jobs. Information includes, among other items, the fax number to which the fax server will send the transmission, job attributes, and recipient and sender information. There is one FaxJob object for each queued job associated with the server.

The FaxJob object has the following methods and properties:

• A method to modify the job queue status of a fax job.
• A method to refresh FaxJob object information.
• Properties to retrieve individual attributes associated with a FaxJob object.

Members

The FaxJob object has these types of members:

• Methods
• Properties

Methods

The FaxJob object has these methods.

Method	Description
Refresh	The Refresh method updates FaxJob object information for the associated fax job.
SetStatus	Call the SetStatus method to pause, resume, cancel, or restart a specified fax job.

 

Properties

The FaxJob object has these properties.

Property	Access type	Description
BillingCode	Read-only	The BillingCode property is a null-terminated string that contains an optional billing code that applies to the fax job.
DeviceStatus	Read-only	The DeviceStatus property is a null-terminated string that describes the status of the port associated with the fax job.
DiscountSend	Read-only	The DiscountSend property is a Boolean value that indicates whether the fax server will transmit the fax job during the discount rate period. The discount period applies only to outgoing fax transmissions.
DisplayName	Read-only	The DisplayName property is a null-terminated string that contains the user-friendly name to associate with the fax job.
FaxNumber	Read-only	The FaxNumber property is a null-terminated string that contains the fax number to which the fax server will transmit the fax job. The FaxNumber property applies only to outgoing fax transmissions.
JobId	Read-only	The JobId property is a number that uniquely identifies the specified fax job.
PageCount	Read-only	The PageCount property is a number that represents the total number of pages in a fax transmission. The PageCount property applies only to outgoing fax transmissions.
QueueStatus	Read-only	The QueueStatus property is a null-terminated string that describes the job queue status of the fax job.
RecipientName	Read-only	The RecipientName property is a null-terminated string that contains the name of the recipient of the fax job.
SenderCompany	Read-only	The SenderCompany property is a null-terminated string that contains the company name for the sender of the fax job. The SenderCompany property applies only to outgoing fax transmissions.
SenderDept	Read-only	The SenderDept property is a null-terminated string that contains the department identifier for the sender of the fax job. The SenderDept property applies only to outgoing fax transmissions.
SenderName	Read-only	The SenderName property is a null-terminated string that contains the name of the sender who initiated the fax job. The SenderName property applies only to outgoing fax transmissions.
Tsid	Read-only	The Tsid property is a null-terminated string that contains the TSID) associated with the fax job.
Type	Read-only	The Type property is a number that describes the type of fax job represented by the object.
UserName	Read-only	The UserName property is a null-terminated string that contains the name of the user who submitted the fax job to the job queue. The UserName property applies only to outgoing fax transmissions.

 

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 FaxJob object's type library information in Visual Basic syntax.

To create a FaxJob object

1. Call the Visual Basic CreateObject function to create a FaxServer object.
2. Call the GetJobs method of the FaxServer object to create a FaxJobs object on the connected fax server.
3. Retrieve the Count property and then the Item property for the FaxJobs collection to create a FaxJob object.

Requirements

Header	Faxcom.h