Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SetAbortProc function

The SetAbortProc function sets the application-defined abort function that allows a print job to be canceled during spooling.

Syntax


int SetAbortProc(
  _In_ HDC       hdc,
  _In_ ABORTPROC lpAbortProc
);

Parameters

hdc [in]

Handle to the device context for the print job.

lpAbortProc [in]

Pointer to the application-defined abort function. For more information about the callback function, see the AbortProc callback function.

Return value

If the function succeeds, the return value is greater than zero.

If the function fails, the return value is SP_ERROR.

Remarks

Note  This is a blocking or synchronous function and might not return immediately. How quickly this function returns depends on run-time factors such as network status, print server configuration, and printer driver implementation—factors that are difficult to predict when writing an application. Calling this function from a thread that manages interaction with the user interface could make the application appear to be unresponsive.

Examples

For an example, see How to Collect Print Job Information from the User.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wingdi.h (include Windows.h)

Library

Gdi32.lib

DLL

Gdi32.dll

See also

Printing
Print Spooler API Functions
AbortDoc
AbortProc

 

 

Community Additions

ADD
Show:
© 2015 Microsoft