Función StartDocA (wingdi.h)

La función StartDoc inicia un trabajo de impresión.

Sintaxis

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

Parámetros

[in] hdc

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

[in] lpdi

Puntero a una estructura DOCINFO que contiene el nombre del archivo de documento y el nombre del archivo de salida.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es mayor que cero. Este valor es el identificador del trabajo de impresión del documento.

Si se produce un error en la función, el valor devuelto es menor o igual que cero.

Observaciones

Nota Esta es una función de bloqueo o sincrónica y podría no devolverse inmediatamente. La rapidez con la que se devuelve esta función 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 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 StartDoc inmediatamente antes de iniciar un trabajo de impresión. El uso de esta función garantiza que los documentos de varias páginas no se intercalan con otros trabajos de impresión.

Las aplicaciones pueden usar el valor devuelto por StartDoc para recuperar o establecer la prioridad de un trabajo de impresión. Llame a la función GetJob o SetJob y proporcione este valor como uno de los argumentos necesarios.

Ejemplos

Para obtener un programa de ejemplo que use esta función, consulte How To: Print Using the GDI Print API.

Nota

El encabezado wingdi.h define StartDoc como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	wingdi.h (incluya Windows.h)
biblioteca de	Gdi32.lib
DLL de	Gdi32.dll

Consulte también

DOCINFO

EndDoc de

GetJob

de funciones de API de administrador de trabajos de impresión

de impresión

setJob