IFaxTiff::get_CallerId

The IFaxTiff::get_CallerId method retrieves the CallerId property for a FaxTiff object. The CallerlD property is a string that identifies the calling device that sent a specified fax 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_CallerId(
  BSTR *pVal  // receives calling device identifier string
);

Parameters

pVal

[out] Pointer to a string that identifies the calling device that sent the fax 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

The IFaxTiff::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 an empty string.

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

  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