IFaxDoc::put_ServerCoverpage

The IFaxDoc::put_ServerCoverpage method changes the ServerCoverpage property for a FaxDoc object. The ServerCoverpage property is a Boolean value that indicates whether the specified cover page file is stored on the fax server.

Visual Basic Reference

HRESULT put_ServerCoverpage(
  BOOL newVal  // new value for server-located cover page flag
);

Parameters

newVal

[in] Specifies the new value to assign to the flag. To indicate that the specified cover page template file (.cov) is a common cover page file stored on the fax server, a fax client application must pass a value of TRUE to the IFaxDoc::put_ServerCoverpage method. 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

You can send a common cover page or a personal cover page with a fax document. 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_ServerCoverpage, IFaxDoc::put_CoverpageName, IFaxDoc::put_FileName, IFaxServer::get_ServerCoverpage, IFaxDoc::put_SendCoverpage