nf-winfax-faxprintcoverpagea.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:winfax.FaxPrintCoverPageA	FaxPrintCoverPageA function (winfax.h)	The FaxPrintCoverPage function prints a fax transmission cover page to the specified device context for a fax client application. (ANSI)	FaxPrintCoverPageA winfax/FaxPrintCoverPageA	fax\_mfax_faxprintcoverpage.htm	Fax	VS|fax|~\fax\faxlegacy_8fmt.htm	12/05/2018	FaxPrintCoverPage, FaxPrintCoverPage function [Fax Service], FaxPrintCoverPageA, FaxPrintCoverPageW, _mfax_faxprintcoverpage, fax._mfax_faxprintcoverpage, winfax/FaxPrintCoverPage, winfax/FaxPrintCoverPageA, winfax/FaxPrintCoverPageW	winfax.h		Windows	Windows 2000 Professional [desktop apps only]	Windows 2000 Server [desktop apps only]				FaxPrintCoverPageW (Unicode) and FaxPrintCoverPageA (ANSI)						WinFax.lib			Windows			19H1	FaxPrintCoverPageA winfax/FaxPrintCoverPageA	c++	APIRef kbSyntax	LibDef	WinFax.lib WinFax.dll	FaxPrintCoverPage FaxPrintCoverPageA FaxPrintCoverPageW

FaxPrintCoverPageA function

-description

The FaxPrintCoverPage function prints a fax transmission cover page to the specified device context for a fax client application.

-parameters

-param FaxContextInfo [in]

Type: const FAX_CONTEXT_INFO*

Pointer to a FAX_CONTEXT_INFO structure that contains a handle to a fax printer device context.

-param CoverPageInfo [in]

Type: const FAX_COVERPAGE_INFO*

Pointer to a FAX_COVERPAGE_INFO structure that contains personal data to display on the cover page of the fax document.

-returns

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError can return one of the following errors.

Return code	Description
ERROR_INVALID_PARAMETER	One or both of the CoverPageInfo or FaxContextInfo parameters are NULL.
ERROR_INVALID_PARAMETER	The SizeOfStruct member of the specified FAX_COVERPAGE_INFO structure is not equal to sizeof(FAX_COVERPAGE_INFO); or the SizeOfStruct member of the specified FAX_CONTEXT_INFO structure is not equal to sizeof(FAX_CONTEXT_INFO).
ERROR_FILE_NOT_FOUND	The fax server cannot locate the file specified by the CoverPageName member of the FAX_COVERPAGE_INFO structure.

-remarks

A device context handle is obtained by using the FaxStartPrintJob function.

The cover page can be a personal cover page stored on the local computer, or it can be a common cover page stored on the fax server.

Note  The application must also call the AbortDoc function or the EndDoc function to complete the print job, and call the DeleteDC function to deallocate the handle to the printer device context. For more information, see Printing a Fax to a Device Context.

 

A fax client application must call the FaxStartPrintJob function before calling the FaxPrintCoverPage function to print a cover page with a fax job. For more information, see Cover Pages and Printing a Fax to a Device Context.

Note

The winfax.h header defines FaxPrintCoverPage as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

FAX_CONTEXT_INFO

FAX_COVERPAGE_INFO

Fax Service Client API Functions

Fax Service Client API for Windows 2000

FaxStartPrintJob