IFaxStatus::get_RecipientName

The IFaxStatus::get_RecipientName method retrieves the RecipientName property for a FaxStatus object. The RecipientName property is a null-terminated string that contains the name of the recipient of an inbound fax transmission.

Visual Basic Reference

HRESULT get_RecipientName(
  BSTR *pVal  // receives fax recipient name
);

Parameters

pVal

[out] Pointer to a null-terminated character string that contains the name of the fax recipient. Note that the RecipientName property is valid only if the Receive property is equal to TRUE.

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 the information is not available, the IFaxStatus::get_RecipientName method returns an empty string.

The IFaxStatus::get_RecipientName 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, IFaxStatus::get_Receive, IFaxPorts, IFaxPort, SysFreeString