Platform SDK: Fax Services

IFaxDoc

The IFaxDoc dual interface is used by a fax client application to transmit fax documents and cover pages. The interface retrieves and sets information about FaxDoc objects. Information includes the name of the file to transmit, the fax number to which the fax server should send the fax, cover page settings, and other optional fax recipient and sender information. The IFaxDoc interface includes the following methods:

When to Implement

You should not implement this interface. The Microsoft® standard implementation provides complete functionality.

When to Use

Use the IFaxDoc interface to send a fax document. You can also use the IFaxDoc interface to retrieve and set the properties of a FaxDoc object.

A client application should not call the CoCreateInstance function to retrieve an IFaxDoc interface pointer. Instead, the application must perform the following steps to create an instance of a FaxDoc object:

  1. Call the CoCreateInstance function to retrieve a pointer to an IFaxServer interface.
  2. Call the IFaxServer::Connect method to connect to an active fax server.
  3. Call the IFaxServer::CreateDocument method to create and initialize a FaxDoc object for the connected fax server. (After calling the IFaxServer::CreateDocument method, you can also call the IUnknown::QueryInterface method to retrieve an IFaxDoc interface pointer.)
  4. Use the IDispatch interface pointer to call IFaxDoc interface methods.
  5. Call the IFaxServer::Disconnect method to disconnect from the fax server.
  6. Call the IUnknown::Release method to destroy the IFaxDoc interface pointer, and the parent IFaxServer interface pointer.

The property methods of the IFaxDoc interface get or set the properties described following. If the property supports read access, the IFaxDoc interface includes a get_PropertyName method. If the property supports write access, the interface includes a put_PropertyName method.

Values are not required for optional properties that appear only on the cover page. The FileName property is required to send a fax transmission using a call to the IFaxDoc::Send method. The FaxNumber property is also required, unless you specify either the CallHandle property, or the ConnectionObject property.

The fax server can supply data from the registry for many properties that begin with Sender. The fax server supplies values if they have been entered under the User Information tab accessed through the Fax icon in Control Panel.

Following are the properties associated with a FaxDoc object. You can find a complete list of IFaxDoc interface methods in Vtable order following the list of properties.

Property Type Access Description
BillingCode BSTR R/W Application- or server-specific billing code that applies to the fax transmission. Billing codes are optional.
CallHandle LONG R/W Optional call handle returned by the TAPI 2.x LINE_CALLSTATE message. The call handle enables transmission of a fax to an active inbound call.
ConnectionObject OBJECT R/W Optional TAPI 3.0 call object. This object enables transmission of a fax to an active inbound call.
CoverpageName BSTR R/W Name of the cover page file to associate with the outbound fax document.
CoverpageNote BSTR R/W Text of a message or note from the sender that pertains to the fax transmission. The note can appear on the cover page.
CoverpageSubject BSTR R/W Subject line of the fax transmission. The subject can appear on the cover page.
DiscountSend BOOL R/W Value that indicates whether the fax server should send the fax transmission during the discount rate period.
DisplayName BSTR R/W User-friendly name to associate with the fax document.
EmailAddress BSTR R/W E-mail address of the sender of the fax document.
FaxNumber BSTR R/W Fax number to which the fax server will transmit the document. The fax number can also appear on the cover page.
FileName BSTR R/W Fully qualified path and file name of the document to transmit.
RecipientAddress BSTR R/W Street address of the recipient of the fax document. The address can appear on the cover page.
RecipientCity BSTR R/W City name of the recipient of the fax document. The city can appear on the cover page.
RecipientCompany BSTR R/W Company name of the recipient of the fax document. The company can appear on the cover page.
RecipientCountry BSTR R/W Country name of the recipient of the fax document. The country can appear on the cover page.
RecipientDepartment BSTR R/W Department identifier of the recipient of the fax document. The department can appear on the cover page.
RecipientHomePhone BSTR R/W Home telephone number of the recipient of the fax document. The telephone number can appear on the cover page.
RecipientName BSTR R/W Name of the recipient of the fax document. The name can appear on the cover page.
RecipientOffice BSTR R/W Office location of the recipient of the fax document. The office can appear on the cover page.
RecipientOfficePhone BSTR R/W Office telephone number of the recipient of the fax document. The telephone number can appear on the cover page.
RecipientState BSTR R/W State name or abbreviation of the recipient of the fax document. The state can appear on the cover page.
RecipientTitle BSTR R/W Title of the recipient of the fax document. The title can appear on the cover page.
RecipientZip BSTR R/W Postal ZIP code of the recipient of the fax document. The ZIP code can appear on the cover page.
SendCoverpage BOOL R/W Value that indicates whether the fax server should send a cover page with the fax document.
SenderAddress BSTR R/W Street address of the sender of the fax document. The address can appear on the cover page.
SenderCompany BSTR R/W Company name of the sender of the fax document. The company can appear on the cover page.
SenderDepartment BSTR R/W Department identifier of the sender of the fax document. The department can appear on the cover page.
SenderFax BSTR R/W Fax number of the sender of the fax document. The fax number can appear on the cover page.
SenderHomePhone BSTR R/W Home telephone number of the sender of the fax document. The telephone number can appear on the cover page.
SenderName BSTR R/W Name of the sender of the fax document. The name can appear on the cover page.
SenderOffice BSTR R/W Office location of the sender of the fax document. The office can appear on the cover page.
SenderOfficePhone BSTR R/W Office telephone number of the sender of the fax document. The telephone number can appear on the cover page.
SenderTitle BSTR R/W Title of the sender of the fax document. The title can appear on the cover page.
ServerCoverpage BOOL R/W Value that indicates whether the specified cover page is a common cover page located on the server.
Tsid BSTR R/W User-defined transmitting station identifier (TSID) to associate with the fax transmission.

Methods in Vtable Order

IUnknown Methods

IDispatch Methods

IFaxDoc Methods

Method Description
get_FileName
put_FileName		 Retrieves or sets a new value for the name of the file associated with an outbound fax document.
get_CoverpageName
put_CoverpageName		 Retrieves or sets a new value for the name of the cover page file to associate with the outbound fax document.
get_SendCoverpage
put_SendCoverpage		 Retrieves or sets a new value for the flag that indicates whether the fax server should include a cover page with the outbound fax document.
get_ServerCoverpage
put_ServerCoverpage		 Retrieves or sets a new value for the flag that indicates whether the cover page specified for the document is a common cover page file stored on the fax server.
get_DiscountSend
put_DiscountSend		 Retrieves or sets a new value for the flag that indicates whether the fax server should transmit the fax document during the discount rate period.
get_RecipientName
put_RecipientName		 Retrieves or sets a new value for the name of the recipient of the outbound fax document.
get_RecipientCompany
put_RecipientCompany		 Retrieves or sets a new value for the company name of the recipient of the outbound fax document.
get_RecipientAddress
put_RecipientAddress		 Retrieves or sets a new value for the street address of the recipient of the outbound fax document.
get_RecipientCity
put_RecipientCity		 Retrieves or sets a new value for the city name of the recipient of the outbound fax document.
get_RecipientState
put_RecipientState		 Retrieves or sets a new value for the state name or state abbreviation of the recipient of the outbound fax document.
get_RecipientZip
put_RecipientZip		 Retrieves or sets a new value for the postal ZIP code of the recipient of the outbound fax document.
get_RecipientCountry
put_RecipientCountry		 Retrieves or sets a new value for the country name of the recipient of the outbound fax document.
get_RecipientTitle
put_RecipientTitle		 Retrieves or sets a new value for the title of the recipient of the outbound fax document.
get_RecipientDepartment
put_RecipientDepartment		 Retrieves or sets a new value for the department identifier of the recipient of the outbound fax document.
get_RecipientOffice
put_RecipientOffice		 Retrieves or sets a new value for the office location of the recipient of the outbound fax document.
get_RecipientHomePhone
put_RecipientHomePhone		 Retrieves or sets a new value for the home telephone number of the recipient of the outbound fax document.
get_RecipientOfficePhone
put_RecipientOfficePhone		 Retrieves or sets a new value for the office telephone number of the recipient of the outbound fax transmission.
get_SenderName
put_SenderName		 Retrieves or sets a new value for the name of the sender of the fax document.
get_SenderCompany
put_SenderCompany		 Retrieves or sets a new value for the company name of the sender of the fax document.
get_SenderAddress
put_SenderAddress		 Retrieves or sets a new value for the street address of the sender of the outbound fax document.
get_SenderTitle
put_SenderTitle		 Retrieves or sets a new value for the title of the sender of the outbound fax document.
get_SenderDepartment
put_SenderDepartment		 Retrieves or sets a new value for the department identifier of the sender of the outbound fax document.
get_SenderOffice
put_SenderOffice		 Retrieves or sets a new value for the office location of the sender of the outbound fax document.
get_SenderHomePhone
put_SenderHomePhone		 Retrieves or sets a new value for the home telephone number of the sender of the outbound fax document.
get_SenderOfficePhone
put_SenderOfficePhone		 Retrieves or sets a new value for the office telephone number of the sender of the fax document.
get_CoverpageNote
put_CoverpageNote		 Retrieves or sets a new value for the text of a cover page message or note from the sender that pertains to the fax transmission.
get_CoverpageSubject
put_CoverpageSubject		 Retrieves or sets a new value for the subject line on the cover page of the fax transmission.
get_Tsid
put_Tsid		 Retrieves or sets a new value for a user-defined transmitting station identifier (TSID) to associate with the fax transmission.
get_BillingCode
put_BillingCode		 Retrieves or sets a new value for an optional application- or server-specific billing code that applies to the fax transmission.
get_EmailAddress
put_EmailAddress		 Retrieves or sets a new value for the e-mail address of the sender of the fax document.
get_DisplayName
put_DisplayName		 Retrieves or sets a new value for the user-friendly name to associate with the fax document.
Send Transmits the document specified by the FaxDoc object to the fax number specified by the object.
get_FaxNumber
put_FaxNumber		 Retrieves or sets a new value for the fax number to which the fax server will send the fax transmission.
putref_ConnectionObject Stores a reference to a TAPI 3.0 call object in a FaxDoc object. The object enables transmission of a fax to an active inbound call.
get_CallHandle
put_CallHandle		 Retrieves or sets a new value for the call handle for an active inbound TAPI 2.x call. The call handle enables transmission of a fax to an active inbound call.
get_SenderFax
put_SenderFax		 Retrieves or sets a new value for the fax number of the sender of the outbound fax document.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces

Built on Wednesday, February 09, 2000