IFaxDocument interface (faxcomex.h)
The IFaxDocument interface defines a messaging object used by a fax client application to compose a fax document and submit it to the fax service for processing.
Inheritance
The IFaxDocument interface inherits from the IDispatch interface. IFaxDocument also has these types of members:
Methods
The IFaxDocument interface has these methods.
| IFaxDocument::ConnectedSubmit The IFaxDocument::ConnectedSubmit method submits a single fax document to the connected IFaxServer. The method returns an array of fax job ID strings, one for each recipient of the fax. |
| IFaxDocument::get_AttachFaxToReceipt The IFaxDocument::get_AttachFaxToReceipt property indicates whether to attach a fax to the receipt. (Get) |
| IFaxDocument::get_Body The IFaxDocument::get_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. (Get) |
| IFaxDocument::get_CoverPage The IFaxDocument::get_CoverPage property is a null-terminated string that contains the name of the cover page template file (.cov) to associate with the fax document. (Get) |
| IFaxDocument::get_CoverPageType The IFaxDocument::get_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. (Get) |
| IFaxDocument::get_DocumentName The IFaxDocument::get_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. (Get) |
| IFaxDocument::get_GroupBroadcastReceipts The IFaxDocument::get_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. (Get) |
| IFaxDocument::get_Note The IFaxDocument::get_Note property is a null-terminated string that contains the contents of the note field on the cover page of the fax. (Get) |
| IFaxDocument::get_Priority The IFaxDocument::get_Priority property specifies the priority to use when sending the fax; for example, normal, low, or high priority. (Get) |
| IFaxDocument::get_ReceiptAddress The IFaxDocument::get_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. (Get) |
| IFaxDocument::get_ReceiptType The IFaxDocument::get_ReceiptType property specifies the type of delivery receipt to deliver when the fax job reaches a final state. (Get) |
| IFaxDocument::get_Recipients The IFaxDocument::get_Recipients property retrieves a collection of one or more recipients for the fax document. |
| IFaxDocument::get_ScheduleTime The IFaxDocument::get_ScheduleTime property indicates the time to submit the fax for processing to the fax service. (Get) |
| IFaxDocument::get_ScheduleType The IFaxDocument::get_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. (Get) |
| IFaxDocument::get_Sender Retrieves an object containing information about the sender of the fax document. |
| IFaxDocument::get_Subject The IFaxDocument::get_Subject property is a null-terminated string that contains the contents of the subject field on the cover page of the fax. (Get) |
| IFaxDocument::put_AttachFaxToReceipt The IFaxDocument::get_AttachFaxToReceipt property indicates whether to attach a fax to the receipt. (Put) |
| IFaxDocument::put_Body The IFaxDocument::get_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. (Put) |
| IFaxDocument::put_CoverPage The IFaxDocument::get_CoverPage property is a null-terminated string that contains the name of the cover page template file (.cov) to associate with the fax document. (Put) |
| IFaxDocument::put_CoverPageType The IFaxDocument::get_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. (Put) |
| IFaxDocument::put_DocumentName The IFaxDocument::get_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. (Put) |
| IFaxDocument::put_GroupBroadcastReceipts The IFaxDocument::get_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. (Put) |
| IFaxDocument::put_Note The IFaxDocument::get_Note property is a null-terminated string that contains the contents of the note field on the cover page of the fax. (Put) |
| IFaxDocument::put_Priority The IFaxDocument::get_Priority property specifies the priority to use when sending the fax; for example, normal, low, or high priority. (Put) |
| IFaxDocument::put_ReceiptAddress The IFaxDocument::get_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. (Put) |
| IFaxDocument::put_ReceiptType The IFaxDocument::get_ReceiptType property specifies the type of delivery receipt to deliver when the fax job reaches a final state. (Put) |
| IFaxDocument::put_ScheduleTime The IFaxDocument::get_ScheduleTime property indicates the time to submit the fax for processing to the fax service. (Put) |
| IFaxDocument::put_ScheduleType The IFaxDocument::get_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. (Put) |
| IFaxDocument::put_Subject The IFaxDocument::get_Subject property is a null-terminated string that contains the contents of the subject field on the cover page of the fax. (Put) |
| IFaxDocument::Submit The IFaxDocument::Submit method submits a single fax document to the fax service for processing. |
Remarks
A default implementation of IFaxDocument and IFaxDocument2 is provided as the FaxDocument object.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | faxcomex.h |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for