FaxPrintCoverPage function

Applies to: desktop apps only

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

Syntax

BOOL WINAPI FaxPrintCoverPage(
  __in  const FAX_CONTEXT_INFO *FaxContextInfo,
  __in  const FAX_COVERPAGE_INFO *CoverPageInfo
);

Parameters

FaxContextInfo [in]

Type: const FAX_CONTEXT_INFO*

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

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.

Return value

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

Requirements

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Header

Winfax.h

Library

WinFax.lib

Unicode and ANSI names

FaxPrintCoverPageW (Unicode) and FaxPrintCoverPageA (ANSI)

See also

Fax Service Client API for Windows 2000
Fax Service Client API Functions
FaxStartPrintJob
FAX_COVERPAGE_INFO
FAX_CONTEXT_INFO

 

 

Build date: 5/5/2012

Community Additions

ADD
Show:
© 2014 Microsoft