IFaxTiff interface

Applies to: desktop apps only

The IFaxTiff dual interface is used by a fax client application to retrieve information about FaxTiff objects. A FaxTiff object represents a Tagged Image File Format Class F (TIFF Class F) file that the fax service has transmitted or received. The fax service embeds custom Tagged Image File Format (TIFF) tags in the file to store information about the fax transmission.

It is not necessary to be familiar with the structure of a TIFF file to use the IFaxTiff interface and access the attributes of FaxTiff objects. This interface provides a convenient alternative to manually parsing the TIFF data in a fax file. The IFaxTiff interface includes the following property methods:

  • Property methods to set and retrieve the name of the fax file described by the FaxTiff object.
  • Property methods to retrieve other attributes of the FaxTiff object, such as device and station identifiers, the fax number, and sender and recipient names.

Note  A fax client application must set the Image property before retrieving another property for a FaxTiff object.

Members

The IFaxTiff interface inherits from the IDispatch interface. IFaxTiff also has these types of members:

Properties

The IFaxTiff interface has these properties.

PropertyAccess typeDescription

CallerId

Read-only

Retrieves the CallerId property for a FaxTiff object. The CallerId property is a string that identifies the calling device that sent a specified fax file.

Csid

Read-only

Retrieves the Csid property for a FaxTiff object. The Csid property is a string that contains CSID information, which is typically the fax number of the device that received the specified fax file.

Image

Read/write

Sets or retrieves the Image property for a FaxTiff object. The Image property is a null-terminated string that contains the full path and file name of the file represented by the FaxTiff object. The file is a TIFF Class F file.

RawReceiveTime

Read-only

Retrieves the RawReceiveTime property for a FaxTiff object. The RawReceiveTime property is the time at which reception began for an inbound fax file, expressed in UTC. This property can also be the time at which reception or transmission began for an archived file.

ReceiveTime

Read-only

Retrieves the ReceiveTime property for a FaxTiff object. The ReceiveTime property is a null-terminated string that contains the time at which reception began for an inbound fax file. The string can contain the time at which reception or transmission began for an archived file.

RecipientName

Read-only

Retrieves the RecipientName property for a FaxTiff object. The RecipientName property is a null-terminated string that contains the name of the recipient for the specified fax file.

RecipientNumber

Read-only

Retrieves the RecipientNumber property for a FaxTiff object. The RecipientNumber property is a null-terminated string that contains the fax number to which a fax was transmitted.

Routing

Read-only

Retrieves the Routing property for a FaxTiff object. The Routing property is a null-terminated string that contains the inbound routing string for a specified fax file.

SenderName

Read-only

Retrieves the SenderName property for a FaxTiff object. The SenderName property is a null-terminated string that contains the name of the user who queued the fax transmission.

TiffTagString

Read/write

Retrieves the TiffTagString property for a FaxTiff object. The TiffTagString property is a null-terminated string that contains the value of a specified TIFF tag (field).

Tsid

Read-only

Retrieves the Tsid property for a FaxTiff object. The Tsid property is a null-terminated string that contains TSID information, which is typically the fax number of the device that sent the specified fax file.

 

Remarks

When to Implement

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

When to Use

Use the IFaxTiff interface to retrieve the properties of a FaxTiff object.

Call the CoCreateInstance function to retrieve a pointer to an IFaxTiff interface and create an instance of a FaxTiff object. It is not necessary to call the IFaxServer::Connect method to initiate a connection with an active fax server. A fax server connection is not required to access the IFaxTiff interface.

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

Following are the properties associated with a FaxTiff object.

Requirements

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Header

Faxcom.h

DLL

Faxcom.dll

See also

Fax Service Client API for Windows 2000
Fax Service Client API Interfaces

 

 

Build date: 5/5/2012

Community Additions

ADD
Show:
© 2014 Microsoft