IFaxStatus::get_CallerId method (faxcom.h)

Article
02/22/2024

Retrieves the CallerId property for the FaxStatus object of a parent FaxPort object. The CallerId property is a string that identifies the calling device that sent an inbound fax job.

This property is read-only.

Syntax

HRESULT get_CallerId(
  BSTR *pVal
);

Parameters

pVal

Return value

None

Remarks

If caller identification information is not available, the IFaxStatus::get_CallerId method returns an empty string.

The IFaxStatus::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