FaxOutgoingMessage object

Applies to: desktop apps only

The FaxOutgoingMessage object is used by a fax client application to retrieve information about a fax message in the archive of outbound faxes. The archive contains faxes transmitted successfully by the fax service. The object enables you to retrieve information about the fax recipient, contained in the FaxRecipient object, and information about the fax sender, contained in the FaxSender object. It also includes methods to delete a message from the archive and to copy the Tagged Image File Format Class F (TIFF Class F) file associated with the fax message, to a file on the local computer.

Members

The FaxOutgoingMessage object has these types of members:

Methods

The FaxOutgoingMessage object has these methods.

MethodDescription
CopyTiff

The CopyTiff method copies the TIFF Class F file associated with the outbound fax message, to a file on the local computer.

Delete

The Delete method deletes the fax message from the outbound archive.

Refresh

Refreshes FaxOutgoingMessage object information from the fax server. When the Refresh method is called, any configuration changes made after the last Save method call are lost.

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

Save

Saves the FaxOutgoingMessage object's data.

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

 

Properties

The FaxOutgoingMessage object has these properties.

PropertyAccess typeDescription

CSID

Read-only

The CSID property is a null-terminated string that contains the CSID for the fax message.

DeviceName

Read-only

The DeviceName property is a null-terminated string that contains the name of the device on which the fax message was transmitted.

DocumentName

Read-only

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

HasCoverPage

Read-only

Indicates if the fax has a cover page.

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

Id

Read-only

The Id property is a null-terminated string that contains a unique identifier for the outbound fax message.

OriginalScheduledTime

Read-only

The OriginalScheduledTime property specifies the time that the fax message was originally scheduled for transmission.

Pages

Read-only

The Pages property is a number that indicates the total number of pages in the outbound fax message.

Priority

Read-only

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

Read

Read/write

Indicates if the fax has been read.

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

ReceiptAddress

Read-only

Specifies the address to which the delivery report is sent.

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

ReceiptType

Read-only

Specifies the type of delivery report that is sent following an attempted transmission.

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

Recipient

Read-only

The Recipient property retrieves an object containing information about the recipient of the fax message.

Retries

Read-only

The Retries property is a value that indicates the number of times that the fax service attempted to transmit an outgoing fax after the initial transmission attempt failed.

Sender

Read-only

The Sender property retrieves an object containing information about the sender of the fax message.

Size

Read-only

The Size property is a value that indicates the size of the TIFF Class F file associated with the outbound fax message.

Subject

Read-only

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

The SubmissionId property is a null-terminated string that contains the unique identifier assigned to the fax message during the submission process. All fax jobs created by the same submission process share the same unique submission ID.

SubmissionTime

Read-only

The SubmissionTime property indicates the time that the outbound fax message was submitted for processing.

TransmissionEnd

Read-only

The TransmissionEnd property indicates the time that the fax outbound message completed transmission.

TransmissionStart

Read-only

The TransmissionStart property indicates the time that the fax outbound message began transmitting.

TSID

Read-only

The TSID property is a null-terminated string that contains the TSID associated with the fax outbound message.

 

Remarks

A FaxOutgoingMessage object is accessed through a FaxOutgoingArchive object or a FaxOutgoingMessageIterator object.

FaxOutgoingArchive, FaxOutgoingMessageIterator and FaxOutgoingMessage objects

To create a FaxOutgoingMessage object in Microsoft Visual Basic, call the GetMessage method of the FaxOutgoingArchive object, or retrieve the Message property of the FaxOutgoingMessageIterator object.

To create a FaxOutgoingMessage object in C++, call the GetMessage method, or the Message method.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

DLL

Fxscomex.dll

IID

CLSID_FaxOutgoingMessage

 

 

Build date: 5/5/2012

Community Additions

ADD
Show:
© 2014 Microsoft