Edit

Share via

IContinueCallback::FContinuePrinting method (docobj.h)

  • Article

Indicates whether a lengthy printing operation should continue.

Syntax

HRESULT FContinuePrinting(
  [in] LONG    nCntPrinted,
  [in] LONG    nCurPage,
  [in] wchar_t *pwszPrintStatus
);

Parameters

[in] nCntPrinted

The total number of pages that have been printed at the time the object receives a call to FContinuePrinting.

[in] nCurPage

The page number of the page being printed at the time the object receives a call to FContinuePrinting.

[in] pwszPrintStatus

A pointer to the message about the current status of the print job. The object being printed may or may not display this message to the user. This parameter can be NULL.

Return value

This method can return the standard return value E_UNEXPECTED, as well as the following values.

Return code Description
S_OK
 Continue the printing operation.
S_FALSE
 Cancel the printing operation as soon as possible.

Remarks

Implementations of IPrint::Print call this method at periodic intervals during the printing process. The IPrint implementation should call back at least after printing each page, so that its client can, if necessary, display useful visual feedback to the user. IPrint::Print can call back multiple times with the same nCntPrinted and nCurPage values, which is sometimes useful when a page being printed is complex and it is appropriate to give a user an opportunity to cancel in mid-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 docobj.h

See also

IContinueCallback

IPrint