IFaxTiff interface (faxcom.h)
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.
Inheritance
The IFaxTiff interface inherits from the IDispatch interface.
Methods
The IFaxTiff interface has these methods.
| IFaxTiff::get_CallerId 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. |
| IFaxTiff::get_Csid Retrieves the Csid property for a FaxTiff object. The Csid property is a string that contains called station identifier (CSID) information, which is typically the fax number of the device that received the specified fax file. |
| IFaxTiff::get_Image Sets or retrieves the Image property for a FaxTiff object. (Get) |
| IFaxTiff::get_RawReceiveTime Retrieves the RawReceiveTime property for a FaxTiff object. |
| IFaxTiff::get_ReceiveTime Retrieves the ReceiveTime property for a FaxTiff object. |
| IFaxTiff::get_RecipientName 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. |
| IFaxTiff::get_RecipientNumber 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. |
| IFaxTiff::get_Routing 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. |
| IFaxTiff::get_SenderName 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. |
| IFaxTiff::get_TiffTagString Retrieves the TiffTagString property for a FaxTiff object. The TiffTagString property is a null-terminated string that contains the value of a specified Tagged Image File Format (TIFF) tag (field). |
| IFaxTiff::get_Tsid Retrieves the Tsid property for a FaxTiff object. The Tsid property is a null-terminated string that contains transmitting station identifier (TSID) information, which is typically the fax number of the device that sent the specified fax file. |
| IFaxTiff::put_Image Sets or retrieves the Image property for a FaxTiff object. (Put) |
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | faxcom.h |
See also
Fax Service Client API Interfaces