Función CommitSpoolData

La función CommitSpoolData notifica al administrador de impresión que se ha escrito una cantidad especificada de datos en un archivo de cola especificado y está listo para representarse.

Sintaxis

HANDLE CommitSpoolData(
  _In_ HANDLE hPrinter,
  _In_ HANDLE hSpoolFile,
       DWORD  cbCommit
);

Parámetros

hPrinter [in]

Identificador de la impresora a la que se envió el trabajo. Debe ser el mismo identificador que se usó para obtener hSpoolFile con GetSpoolFileHandle.

hSpoolFile [in]

Identificador del archivo de cola que se va a cambiar. En la primera llamada de CommitSpoolData, debe ser el mismo identificador devuelto por GetSpoolFileHandle. Las llamadas posteriores a CommitSpoolData deben pasar el identificador devuelto por la llamada anterior. Vea la sección Comentarios.

cbCommit

Número de bytes confirmados en el administrador de trabajos de impresión.

Valor devuelto

Si la función se ejecuta correctamente, devuelve un identificador al archivo de cola.

Si se produce un error en la función, devuelve INVALID_HANDLE_VALUE.

Comentarios

Las aplicaciones que envían un trabajo de impresión de cola pueden llamar a GetSpoolFileHandle y, a continuación, escribir datos directamente en el identificador de archivo de cola llamando a WriteFile. Para notificar al administrador de trabajos de impresión que el archivo contiene datos que están listos para representarse, la aplicación debe llamar a CommitSpoolData y proporcionar el número de bytes disponibles.

Si se llama a CommitSpoolData varias veces, cada llamada debe usar el identificador de archivo de cola devuelto por la llamada anterior. Cuando no se escriban más datos en el archivo de cola, se debe llamar a CloseSpoolFileHandle para el identificador de archivo devuelto por la última llamada a CommitSpoolData.

Antes de llamar a CommitSpoolData, las aplicaciones deben establecer el puntero de archivo en la posición que tenía antes de escribir datos en el archivo. En el proceso de representar los datos en el archivo de cola, el administrador de trabajos de impresión moverá los bytes cbCommit del puntero del archivo de cola desde el valor actual del puntero de archivo.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Encabezado	Winspool.h (incluye Windows.h)
Biblioteca	Winspool.lib
Archivo DLL	WinSpool.drv

Consulte también

Impresión

Funciones de la API del administrador de trabajos de impresión

GetSpoolFileHandle

CloseSpoolFileHandle