IFaxTiff::get_Image method (faxcom.h)

Article
02/22/2024

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 Tagged Image File Format Class F (TIFF Class F) file.

This property is read/write.

Syntax

HRESULT get_Image(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

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

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

A fax client application can use this retrieval method to determine the name of the facsimile image file that is open as a result of successful assignment of the Image property.

The 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 Freeing Fax Resources.

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
DLL	Faxcom.dll

Share via