Função CommitSpoolData

A função CommitSpoolData notifica o spooler de impressão de que uma quantidade especificada de dados foi gravada em um arquivo de spool especificado e está pronta para ser renderizada.

Sintaxe

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

Parâmetros

hPrinter [in]

Um identificador para a impressora para a qual o trabalho foi enviado. Esse deve ser o mesmo identificador usado para obter hSpoolFile com GetSpoolFileHandle.

hSpoolFile [in]

Um identificador para o arquivo de spool que está sendo alterado. Na primeira chamada de CommitSpoolData, esse deve ser o mesmo identificador retornado por GetSpoolFileHandle. Chamadas subsequentes para CommitSpoolData devem passar o identificador retornado pela chamada anterior. Consulte Observações.

cbCommit

O número de bytes confirmados no spooler de impressão.

Valor retornado

Se a função for bem-sucedida, ela retornará um identificador para o arquivo de spool.

Se a função falhar, ela retornará INVALID_HANDLE_VALUE.

Comentários

Os aplicativos que enviarem um trabalho de impressão de spooler podem chamar GetSpoolFileHandle e gravar dados diretamente no identificador de arquivo de spool chamando WriteFile. Para notificar o spooler de impressão de que o arquivo contém dados que estão prontos para serem renderizados, o aplicativo deve chamar CommitSpoolData e fornecer o número de bytes disponíveis.

Se CommitSpoolData for chamado várias vezes, cada chamada deverá usar o identificador de arquivo de spool retornado pela chamada anterior. Quando não houver mais dados gravados no arquivo de spool, CloseSpoolFileHandle deverá ser chamado para o identificador de arquivo retornado pela última chamada para CommitSpoolData.

Antes de chamar CommitSpoolData, os aplicativos devem definir o ponteiro do arquivo para a posição que ele tinha antes de gravar dados no arquivo. No processo de renderização dos dados no arquivo spooler, o spooler de impressão moverá o ponteiro do arquivo de spool cbCommit bytes do valor atual do ponteiro de arquivo.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Cabeçalho	Winspool.h (inclua Windows.h)
Biblioteca	Winspool.lib
DLL	WinSpool.drv

Confira também

Impressão

Funções da API do Spooler de impressão

GetSpoolFileHandle

CloseSpoolFileHandle