Platform SDK: Fax Services

FaxTiff Object (Visual Basic)

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.

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:

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

When to Implement

You should not implement this class. The Microsoft standard implementation provides complete functionality. You can use the 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")

Following is a list of the Visual Basic properties of FaxTiff objects.

Property Visual Basic Example
CallerId
STRING
Read-only
String that identifies the calling device that sent the specified fax file.

Dim strCallerid As String
strCallerid = objFaxTiff.CallerId
Csid
STRING
Read-only
Called station identifier (CSID) associated with the specified fax file.

Dim strCsid As String
strCsid = objFaxTiff.Csid
Image
STRING
Read/Write
Full path and file name of the fax file described by the FaxTiff object. The file is a TIFF Class F file. A fax client application must set the Image property before retrieving another property for a FaxTiff object.

' Retrieve
Dim strImage As String
strImage = objFaxTiff.Image
' Assign
objFaxTiff.Image = "MyFile"
RawReceiveTime
VARIANT
Read-only
Time, expressed in UTC, when reception began for the specified fax file. (This method can retrieve a transmission time for an archived file.)

Dim RawTime ' Variant by default
RawTime = objFaxTiff.RawReceiveTime
ReceiveTime
STRING
Read-only
Time, in a formatted string, when reception began for the specified fax file. (This can retrieve a transmission time for an archived file.)

Dim strRtime As String
strRtime = objFaxTiff.ReceiveTime
RecipientName
STRING
Read-only
Name of the recipient of the specified fax file.

Dim strRname As String
strRname = objFaxTiff.RecipientName
RecipientNumber
STRING
Read-only
Fax number for the recipient of the specified fax file.

Dim strRnumber As String
strRnumber = objFaxTiff.RecipientNumber
Routing
STRING
Read-only
Inbound routing string for the specified fax file. Routing information is specific to a fax service provider.

Dim strRouting As String
strRouting = objFaxTiff.Routing
SenderName
STRING
Read-only
Name of the sender of the specified fax file.

Dim strSname As String
strSname = objFaxTiff.SenderName
TiffTagString
STRING
Read-only
 
String that contains the value of a specified TIFF tag (field).

Dim strProp As String
strProp = objFaxDoc.TiffTagString(269)
Tsid
STRING
Read-only
Transmitting station identifier (TSID) associated with the specified fax file.

Dim strTsid As String
strTsid = objFaxTiff.Tsid