Función StartDocA (wingdi.h)

Artículo
03/08/2023

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

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 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 ver un programa de ejemplo que usa 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos


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