Función AbortDoc (wingdi.h)

Artículo
03/04/2024

La función AbortDoc detiene el trabajo de impresión actual y borra todo lo dibujado desde la última llamada a la función StartDoc .

Sintaxis

int AbortDoc(
  [in] HDC hdc
);

Parámetros

[in] hdc

Controle el contexto del dispositivo para el trabajo de impresión.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es mayor que cero.

Si se produce un error en la función, el valor devuelto es SP_ERROR.

Comentarios

Nota Se trata de una función de bloqueo o sincrónica que podría no devolverse inmediatamente. La rapidez con la que esta función devuelve depende de factores en tiempo de ejecución, como el estado de red, la configuración del servidor de impresión y la implementación del controlador de impresora, factores que son difíciles de predecir al escribir una aplicación. Llamar a esta función desde un subproceso que administra la interacción con la interfaz de usuario podría hacer que la aplicación parezca que no responde.

Las aplicaciones deben llamar a la función AbortDoc para detener un trabajo de impresión si se produce un error o para detener un trabajo de impresión después de que el usuario cancele ese trabajo. Para finalizar un trabajo de impresión correcto, una aplicación debe llamar a la función EndDoc .

Si se usó print Manager para iniciar el trabajo de impresión, al llamar a AbortDoc se borra todo el trabajo de cola, de modo que la impresora no reciba nada. Si el Administrador de impresión no se usó para iniciar el trabajo de impresión, es posible que los datos ya se hayan enviado a la impresora. En este caso, el controlador de impresora restablece la impresora (siempre que sea posible) y finaliza el trabajo de impresión.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wingdi.h (incluye Windows.h)
Library	Gdi32.lib
Archivo DLL	Gdi32.dll