FaxTiff object
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.
You do not need to be familiar with the structure of a TIFF file to access the attributes of a FaxTiff object. This object provides a convenient alternative to manually parsing the TIFF data in a fax file. The FaxTiff object has the following properties:
- A property to return or set the name of the fax file described by the FaxTiff object.
- Properties to return 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 FaxTiff object has these types of members:
Properties
The FaxTiff object has these properties.
Property | Access type | Description |
---|---|---|
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 class. The Microsoft standard implementation provides complete functionality. You can use the Microsoft Visual Basic Object Browser to view the FaxTiff object's type library information in Visual Basic syntax.
To create a FaxTiff object, call the Visual Basic CreateObject function as illustrated in the following sample:
Dim FaxTiff as Object
Set FaxTiff = CreateObject("FaxTiff.FaxTiff")
Requirements
Header |
|