IFaxDoc::get_CoverpageName

The IFaxDoc::get_CoverpageName method retrieves the CoverpageName property for a FaxDoc object. The CoverpageName property is a null-terminated string that contains the name of the cover page template file (.cov) associated with the object.

Visual Basic Reference

HRESULT get_CoverpageName(
  BSTR *pVal  // receives cover page file name
);

Parameters

pVal

[out] Pointer to a null-terminated string that contains the name of the cover page file to associate with the fax document. The string can consist of the file name only for a common cover page file or for a personal cover page file. It can also be the fully qualified path to any other 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

The fax server supplies data for the fields in the cover page template file at transmission time, using properties specified for the FaxDoc object.

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 specified 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.

The IFaxDoc::get_CoverpageName 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.

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::put_CoverpageName, IFaxDoc::put_ServerCoverpage, IFaxDoc::put_FileName, IFaxServer::get_ServerCoverpage, IFaxDoc::put_SendCoverpage, SysFreeString