FaxDocument object

Applies to: desktop apps only

The FaxDocument messaging object is used by a fax client application to compose a fax document and submit it to the fax service for processing.

Members

The FaxDocument object has these types of members:

Methods

The FaxDocument object has these methods.

MethodDescription
ConnectedSubmit

The ConnectedSubmit method submits a single fax document to the connected FaxServer. The method returns an array of fax job ID strings, one for each recipient of the fax.

ConnectedSubmit2

Submits one or more fax documents to the connected FaxServer. This method returns an array of fax job ID strings, one for each recipient of the fax.

Note  This method is supported only in Windows Vista and later.

Submit

The Submit method submits a single fax document to the fax service for processing.

Submit2

Submits one or more documents to the fax service for processing.

Note  This method is supported only in Windows Vista and later.

 

Properties

The FaxDocument object has these properties.

PropertyAccess typeDescription

AttachFaxToReceipt

Read/write

The AttachFaxToReceipt property indicates whether to attach a fax to the receipt.

Bodies

Read/write

Provides a collection of one or more documents to the fax document.

Note  This property is supported only in Windows Vista and later.

Body

Read/write

The Body property provides the path to the file that comprises the body of a fax. The body of a fax consists of the fax pages other than the cover page.

CoverPage

Read/write

The CoverPage property is a null-terminated string that contains the name of the cover page template file (.cov) to associate with the fax document.

CoverPageType

Read/write

The CoverPageType property is a value from an enumeration that indicates whether a specified cover page template file (.cov) is a server-based cover page file or a local-computer-based cover page file. You can also specify that no file is used.

DocumentName

Read/write

The DocumentName property is a null-terminated string that contains the user-friendly name to display for the fax document. The value is for display purposes only.

GroupBroadcastReceipts

Read/write

The GroupBroadcastReceipts property is a Boolean value that indicates whether to send an individual delivery receipt for each recipient of the broadcast, or to send a summary receipt for all the recipients.

Note

Read/write

The Note property is a null-terminated string that contains the contents of the note field on the cover page of the fax.

Priority

Read/write

The Priority property specifies the priority to use when sending the fax; for example, normal, low, or high priority.

ReceiptAddress

Read/write

The ReceiptAddress property is a null-terminated string that indicates the email address to which the fax service should send a delivery receipt when the fax job reaches a final state.

ReceiptType

Read/write

The ReceiptType property specifies the type of delivery receipt to deliver when the fax job reaches a final state.

Recipients

Read-only

The Recipients property retrieves a collection of one or more recipients for the fax document.

ScheduleTime

Read/write

The ScheduleTime property indicates the time to submit the fax for processing to the fax service.

ScheduleType

Read/write

The ScheduleType property indicates when to schedule the fax job; for example, you can specify that the fax service send the fax immediately, at a specified time, or during a predefined discount period.

Sender

Read-only

Retrieves an object containing information about the sender of the fax document.

Subject

Read/write

The Subject property is a null-terminated string that contains the contents of the subject field on the cover page of the fax.

SubmissionId

Read-only

Retrieves the submission identifier for the fax document. Every job in a given broadcast receives the same submission identifier.

Note  This property is supported only in Windows Vista and later.

 

Remarks

The FaxDocument object implements the IFaxDocument interface in Windows XP and earlier. It implements the IFaxDocument2 interface in Windows Vista and later.

Use the FaxDocument object to set and retrieve information about fax transmissions. This includes information about fax recipients, contained in the FaxRecipients object, and information about the fax sender, contained in the FaxSender object.

You can send a fax to one or more recipients.

FaxDocument, FaxSender, FaxRecipients, and FaxRecipient objects

To create a FaxDocument object in Microsoft Visual Basic, call the Visual Basic CreateObject function.

To create a FaxDevices object in C++, call the CoCreateInstance function. An example of the creation of a FaxDocument object is provided in the topic Creating the Root Object in C++.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

DLL

Fxscomex.dll

IID

CLSID_FaxDocument

See also

Fax Service object hierarchy
IFaxDocument
IFaxDocument2

 

 

Build date: 5/5/2012

Community Additions

ADD
Show:
© 2014 Microsoft