IFaxDoc::get_CoverpageNote

The IFaxDoc::get_CoverpageNote method retrieves 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 get_CoverpageNote(
  BSTR *pVal  // receives cover page note text
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the text of a message or note from the sender that pertains to the fax transmission. The text will appear on the cover page.

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.

The IFaxDoc::get_CoverpageNote 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, IFaxDoc, IFaxDoc::put_CoverpageNote, SysFreeString