IFaxTiff::get_Image

The IFaxTiff::get_Image method 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 Tagged Image File Format, Class F for facsimile (TIFF Class F) file.

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_Image(
  BSTR *pVal  // receives open fax file name
);

Parameters

pVal

[out] Pointer to a string that contains the fully qualified path and name of the fax image file.

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

A fax client application can call the IFaxTiff::get_Image retrieval method to determine the name of the facsimile image file which is open as a result of a successful call to the IFaxTiff::put_Image method.

The IFaxTiff::get_Image 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 Retrieving Fax File Data and 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, IFaxTiff::put_Image, SysFreeString