IFaxDoc::put_CoverpageNote

The IFaxDoc::put_CoverpageNote method changes the CoverpageNote property of a FaxDoc object. The CoverpageNote property is a null-terminated string that contains the text of a message or note from the sender that pertains to the fax transmission.

Visual Basic Reference

HRESULT put_CoverpageNote(
  BSTR newVal  // new value for cover page note text
);

Parameters

newVal

[in] Specifies the new value to assign to the CoverpageNote 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 cover page note 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_CoverpageNote