IFaxServer::get_ServerCoverpage

The IFaxServer::get_ServerCoverpage method retrieves the ServerCoverpage property for a FaxServer object. The ServerCoverpage property is a Boolean value that indicates whether the fax server permits the use of common cover pages only.

Visual Basic Reference

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

Parameters

pVal

[out] Pointer to a Boolean variable that indicates whether fax client applications can include a user-designed cover page with a fax transmission, or whether the fax server permits the use of common cover pages only.

If this value is TRUE, the client must use the common cover page located on the fax server. If this value is FALSE, the client can use any cover page file.

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

If you set the ServerCoverpage property equal to TRUE, users will be able to transmit only approved cover pages that are located on the fax server. 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, IFaxServer, IFaxServer::put_ServerCoverpage