| Platform SDK: Fax Services |
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 for facsimile (TIFF Class F) file that the fax service has transmitted or received. The fax service embeds custom 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:
Note A fax client application must call the IFaxTiff::put_Image method to set the Image property before retrieving another property for a FaxTiff object.
You should not implement this interface. The Microsoft® standard implementation provides complete functionality.
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. You can find a complete list of IFaxTiff interface methods in Vtable order following the list of properties.
| Property | Type | Access | Description |
|---|---|---|---|
| CallerId | BSTR | R | Information that identifies the calling device that sent the specified fax file. |
| Csid | BSTR | R | Called station identifier (CSID) associated with the fax file. |
| Image | BSTR | R/W | Full path and file name of the fax image file described by this FaxTiff object. The file is a Tagged Image File Format, Class F for facsimile (TIFF Class F) file. |
| RawReceiveTime | VARIANT | R | Time when reception began for the specified inbound fax file, or the time when reception or transmission began for an archived file. The time is expressed in Coordinated Universal Time (UTC). |
| ReceiveTime | BSTR | R | Time when reception began for the specified inbound fax file, or the time when reception or transmission began for an archived file. The property is a formatted time string. |
| RecipientName | BSTR | R | Name of the recipient of the specified fax file. |
| RecipientNumber | BSTR | R | Fax number to which the specified fax file was transmitted. |
| Routing | BSTR | R | Inbound routing string for the specified fax file. |
| SenderName | BSTR | R | Name of the user who queued the specified fax transmission. |
| TiffTagString | BSTR | R | TIFF tag (field) string associated with a TIFF tag numeric identifier. (You can retrieve this property only for the first page of a TIFF file.) |
| Tsid | BSTR | R | Transmitting station identifier (TSID) associated with the specified fax file. |
IUnknown Methods
IFaxTiff Methods
| Method | Description |
|---|---|
| get_ReceiveTime | Retrieves the time, in a formatted string, when reception began for the specified fax file. (This method can retrieve a transmission time for an archived file.) |
| get_Image put_Image |
Retrieves or sets a new value for the full path and file name of the fax file described by this FaxTiff object. The file is a Tagged Image File Format, Class F for facsimile (TIFF Class F) file. |
| get_RecipientName | Retrieves the name of the recipient of the specified fax file. |
| get_SenderName | Retrieves the name of the sender of the specified fax file. |
| get_Routing | Retrieves the inbound routing string for the specified fax file. |
| get_CallerId | Retrieves a string that identifies the calling device that sent the specified fax file. |
| get_Csid | Retrieves the called station identifier (CSID) associated with the specified fax file. |
| get_Tsid | Retrieves the transmitting station identifier (TSID) associated with the specified fax file. |
| get_RecipientNumber | Retrieves the fax number for the recipient of the specified fax file. |
| get_RawReceiveTime | Retrieves the time, expressed in UTC, when reception began for the specified fax file. (This method can retrieve a transmission time for an archived file.) |
| get_TiffTagString | Retrieves the TIFF tag (field) string associated with a TIFF tag numeric identifier. (You can retrieve this property only for the first page of a TIFF file.) |
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Unsupported.
Header: Declared in faxcom.h.
Import Library: Included as a resource in faxcom.dll.
Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces