IFaxStatus::get_CallerId

The IFaxStatus::get_CallerId method 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.

Visual Basic Reference

HRESULT get_CallerId(
  BSTR *pVal  // receives calling device identifier string
);

Parameters

pVal

[out] Pointer to a null-terminated character string that identifies the calling device for an inbound fax job. This parameter has no meaning for an outbound job.

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

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

  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, IFaxStatus, IFaxPorts, IFaxPort, SysFreeString