Platform SDK: Fax Services

IFaxDoc::put_RecipientHomePhone

The IFaxDoc::put_RecipientHomePhone method changes the RecipientHomePhone property of a FaxDoc object. The RecipientHomePhone property is a null-terminated string that contains the home telephone number of the recipient of the outbound fax transmission.

Visual Basic Reference

HRESULT put_RecipientHomePhone(
  BSTR newVal  // new value for fax recipient's home phone
);

Parameters

newVal
[in] Specifies the new value to assign to the RecipientHomePhone property.

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 fax recipient's home telephone number can appear on the cover page.

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, IFaxDoc, IFaxDoc::get_RecipientHomePhone