IFaxDoc::put_RecipientCity

The IFaxDoc::put_RecipientCity method changes the RecipientCity property of a FaxDoc object. The RecipientCity property is a null-terminated string that contains the city name of the recipient of the outbound fax transmission.

Visual Basic Reference

HRESULT put_RecipientCity(
  BSTR newVal  // new value for fax recipient's city
);

Parameters

newVal

[in] Specifies the new value to assign to the RecipientCity 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 city name 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_RecipientCity