Edit

Share via

IFaxDoc::get_SendCoverpage method (faxcom.h)

  • Article

Sets or retrieves the SendCoverpage property for a FaxDoc object. The SendCoverpage property is a Boolean value that indicates whether the specified cover page file is stored on the fax server.

This property is read/write.

Syntax

HRESULT get_SendCoverpage(
  BOOL *pVal
);

Parameters

pVal

Return value

None

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

You can call the ServerCoverpage method to determine whether the fax server is configured to permit personal cover pages.

The IFaxDoc::get_SendCoverpage 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

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header faxcom.h
DLL Faxcom.dll

See also

Fax Service Client API Interfaces

Fax Service Client API for Windows 2000

IFaxDoc

IFaxDoc::get_FileName

IFaxDoc::get_ServerCoverpage

SysFreeString