IFaxTiff::get_TiffTagString

The IFaxTiff::get_TiffTagString method 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). For more information about Tagged Image File Format, Class F for facsimile (TIFF Class F) files, see Fax Image Format. For current information about TIFF tags, or for the list of valid TIFF tag numbers, contact Adobe Systems Incorporated.

A fax client application must call the IFaxTiff::put_Image method to set the Image property before retrieving another property for a FaxTiff object.

Visual Basic Reference

HRESULT get_TiffTagString(
  WORD tagID  
  BSTR *pVal  
);

Parameters

tagID

[in] Pointer to a variable that specifies the numeric identifier of the TIFF tag to retrieve. For more information, see the following Remarks section.

pVal

[out] Pointer to a string that contains the value of the TIFF tag specified by the tagID parameter.

Return Values

Returns an HRESULT value indicating success or failure. If the method succeeds, it returns S_OK. Otherwise, it returns a COM-defined error code.

You should not check directly for success or failure. Use the COM SUCCEEDED and FAILED macros instead.

Remarks

The IFaxTiff::get_TiffTagString method sets the pVal parameter to a string that represents the value of the TIFF tag, if it is available. If the information is not available, the method returns an empty string.

You can call the IFaxTiff::get_TiffTagString method to retrieve information about any TIFF tag, including those that the fax service does not support. Note that you can retrieve this property only for the first page of a TIFF file.

The IFaxTiff::get_TiffTagString method allocates the memory required for the buffer pointed to by the pVal parameter. The client application must call the SysFreeString function to deallocate the resources associated with this parameter. For more information, see Freeing Fax Resources.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in faxcom.h.
  Import Library: Included as a resource in faxcom.dll.

See Also

Fax Service Client Application Programming Interface Overview, Fax Service Client API Interfaces, IFaxTiff, SysFreeString