IFaxDoc::get_SendCoverpage

The IFaxDoc::get_SendCoverpage method retrieves the SendCoverpage property for a FaxDoc object. The SendCoverpage property is a Boolean value that indicates whether the fax service transmits a cover page with the fax document.

Visual Basic Reference

HRESULT get_SendCoverpage(
  BOOL *pVal  // receives include cover page flag
);

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether the fax service includes a user-defined cover page or a common cover page with the fax transmission. If this parameter is equal to TRUE, the fax service will include a cover page. For more information, see the following Remarks section.

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

To send a cover page with a fax document, the following are required:

• The SendCoverpage property must be equal to TRUE.
• The CoverpageName property must specify a valid cover page file.

In addition, the ServerCoverpage property must be equal to TRUE if the cover page file is a common cover page file. For more information, see IFaxDoc::put_CoverpageName.

You can call the IFaxServer::get_ServerCoverpage method to determine if the fax server is configured to permit personal cover pages.

For more information, see Cover Pages and Sending a 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_CoverpageName, IFaxDoc::get_FileName, IFaxDoc::put_SendCoverpage, IFaxServer::get_ServerCoverpage