IFaxTiff::get_CallerId method (faxcom.h)

Article
02/22/2024

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.

This property is read-only.

Syntax

HRESULT get_CallerId(
  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.

The get_CallerId method sets the pVal parameter to the string that identifies the calling device, if it is available. If the information is not available, the method returns "Unavailable".

The CallerId property is a string that identifies the calling device, if it is available. If the information is not available, CallerId is an empty string.

The get_CallerId 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