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

Artigo
06/13/2023

A API do Spooler de Impressão contém as funções e estruturas de dados que os aplicativos usam para gerenciar o spooler de impressão do Windows e as impressoras e os trabalhos de impressão que ele controla.

As funções da API do Spooler de Impressão são divididas nos seguintes grupos:

Funções de trabalho de impressão
Funções de interface do usuário da impressora
Funções de impressora
Funções de notificação de alteração de impressora
Funções de formulário de impressora
Imprimir Funções do Spooler

Funções de trabalho de impressão

Essas funções enviam trabalhos de impressão para uma impressora e acompanham e controlam os trabalhos de impressão no spooler de impressão.

Função	Descrição
Addjob	A função AddJob adiciona um trabalho de impressão à lista de trabalhos de impressão que podem ser agendados pelo spooler de impressão. A função recupera o nome do arquivo que você pode usar para armazenar o trabalho.
ClosePrinter	A função ClosePrinter fecha o objeto de impressora especificado.
DocumentEvent	A função DocumentEvent é um manipulador de eventos para eventos associados à impressão de um documento.
Documentproperties	A função DocumentProperties recupera ou modifica informações de inicialização da impressora ou exibe uma folha de propriedades de configuração de impressora para a impressora especificada.
EndDocPrinter	A função EndDocPrinter encerra um trabalho de impressão para a impressora especificada.
EndPagePrinter	A função EndPagePrinter notifica o spooler de impressão de que o aplicativo está no final de uma página em um trabalho de impressão.
EnumJobs	A função EnumJobs recupera informações sobre um conjunto especificado de trabalhos de impressão para uma impressora especificada.
Getjob	A função GetJob recupera informações sobre um trabalho de impressão especificado.
OpenPrinter	A função OpenPrinter recupera um identificador para a impressora ou servidor de impressão especificado ou outros tipos de identificadores no subsistema de impressão.
OpenPrinter2	Recupera um identificador para a impressora, o servidor de impressão ou outros tipos de identificadores especificados no subsistema de impressão, ao mesmo tempo em que define algumas das opções da impressora.
ReportJobProcessingProgress	Relata ao serviço Spooler de Impressão se um trabalho de impressão XPS está no spooling ou na fase de renderização e qual parte do processamento está em andamento no momento.
ScheduleJob	A função ScheduleJob solicita que o spooler de impressão agende um trabalho de impressão especificado para impressão.
SetJob	A função SetJob pausa, retoma, cancela ou reinicia um trabalho de impressão em uma impressora especificada. Você também pode usar a função SetJob para definir parâmetros de trabalho de impressão, como a prioridade do trabalho de impressão e o nome do documento.
StartDocPrinter	A função StartDocPrinter notifica o spooler de impressão de que um documento deve ser usado para impressão.
StartPagePrinter	A função StartPagePrinter notifica o spooler de que uma página está prestes a ser impressa na impressora especificada.

Funções de interface do usuário da impressora

Essas funções exibem uma interface do usuário que permite que o usuário selecione ou configure uma impressora.

Função	Descrição
AdvancedDocumentProperties	A função AdvancedDocumentProperties exibe uma caixa de diálogo de configuração de impressora para a impressora especificada, permitindo que o usuário configure essa impressora.
ConfigurePort	A função ConfigurePort exibe a caixa de diálogo de configuração de porta para uma porta no servidor especificado.
ConnectToPrinterDlg	A função ConnectToPrinterDlg exibe uma caixa de diálogo que permite que os usuários naveguem e se conectem a impressoras em uma rede. Se o usuário selecionar uma impressora, a função tentará criar uma conexão com ela; se um driver adequado não estiver instalado no servidor, o usuário recebe a opção de criar uma impressora localmente.
PrinterProperties	A função PrinterProperties exibe uma folha de propriedades de propriedades da impressora para a impressora especificada.

Funções de impressora

Essas funções adicionam e configuram as impressoras que o spooler de impressão usa.

Função	Descrição
AbortPrinter	A função AbortPrinter excluirá o arquivo de spool de uma impressora se a impressora estiver configurada para spooling.
AddPrinter	A função AddPrinter adiciona uma impressora à lista de impressoras com suporte para um servidor especificado.
AddPrinterConnection	A função AddPrinterConnection adiciona uma conexão à impressora especificada para o usuário atual.
AddPrinterConnection2	Adiciona uma conexão à impressora especificada para o usuário atual e especifica detalhes da conexão.
DeletePrinter	A função DeletePrinter exclui o objeto de impressora especificado.
DeletePrinterConnection	A função DeletePrinterConnection exclui uma conexão com uma impressora que foi estabelecida por uma chamada para AddPrinterConnection ou ConnectToPrinterDlg.
DeletePrinterData	A função DeletePrinterData exclui os dados de configuração especificados para uma impressora. Os dados de configuração de uma impressora consistem em um conjunto de valores nomeados e tipado. A função DeletePrinterData exclui um desses valores, especificados pelo nome do valor.
DeletePrinterDataEx	A função DeletePrinterDataEx exclui um valor especificado dos dados de configuração de uma impressora. Os dados de configuração de uma impressora consistem em um conjunto de valores nomeados e tipado armazenados em uma hierarquia de chaves do Registro. A função exclui um valor especificado em uma chave especificada.
DeletePrinterKey	A função DeletePrinterKey exclui uma chave especificada e todas as subchaves para uma impressora especificada.
EnumPrinterData	A função EnumPrinterData enumera os dados de configuração de uma impressora especificada.
EnumPrinterDataEx	A função EnumPrinterDataEx enumera todos os nomes de valor e dados de uma impressora e chave especificadas.
EnumPrinterKey	A função EnumPrinterKey enumera as subchaves de uma chave especificada para uma impressora especificada.
EnumPrinters	A função EnumPrinters enumera impressoras disponíveis, servidores de impressão, domínios ou provedores de impressão.
FlushPrinter	A função FlushPrinter envia um buffer para a impressora para limpá-lo de um estado transitório.
GetDefaultPrinter	A função GetDefaultPrinter recupera o nome da impressora padrão para o usuário atual no computador local.
GetPrinter	A função GetPrinter recupera informações sobre uma impressora especificada.
GetPrinterData	A função GetPrinterData recupera dados de configuração para a impressora ou servidor de impressão especificado.
GetPrinterDataEx	A função GetPrinterDataEx recupera dados de configuração para a impressora ou servidor de impressão especificado. GetPrinterDataEx pode recuperar valores armazenados pela função SetPrinterData . Além disso, GetPrinterDataEx pode recuperar valores armazenados em uma chave especificada pela função SetPrinterDataEx .
IsValidDevmode	A função IsValidDevmode verifica se o conteúdo de uma estrutura DEVMODE é válido.
ReadPrinter	A função ReadPrinter recupera dados da impressora especificada.
ResetPrinter	A função ResetPrinter especifica os valores de tipo de dados e modo de dispositivo a serem usados para imprimir documentos enviados pela função StartDocPrinter . Esses valores podem ser substituídos usando a função SetJob após o início da impressão do documento.
SetDefaultPrinter	A função SetDefaultPrinter define o nome da impressora padrão para o usuário atual no computador local.
SetPort	A função SetPort define o status associado a uma porta de impressora.
SetPrinter	A função SetPrinter define os dados de uma impressora especificada ou define o estado da impressora especificada pausando a impressão, retomando a impressão ou limpando todos os trabalhos de impressão.
SetPrinterData	A função SetPrinterData define os dados de configuração de uma impressora ou servidor de impressão.
SetPrinterDataEx	A função SetPrinterDataEx define os dados de configuração de uma impressora ou servidor de impressão. A função armazena os dados de configuração sob a chave do Registro da impressora.
WritePrinter	A função WritePrinter notifica o spooler de impressão de que os dados devem ser gravados na impressora especificada.

Funções de notificação de alteração de impressora

Essas funções permitem que um aplicativo seja notificado sobre alterações no status de uma impressora.

Função	Descrição
FindClosePrinterChangeNotification	A função FindClosePrinterChangeNotification fecha um objeto de notificação de alteração criado chamando a função FindFirstPrinterChangeNotification . A impressora ou o servidor de impressão associado ao objeto de notificação de alteração não será mais monitorado por esse objeto.
FindFirstPrinterChangeNotification	A função FindFirstPrinterChangeNotification cria um objeto de notificação de alteração e retorna um identificador para o objeto . Em seguida, você pode usar esse identificador em uma chamada para uma das funções de espera para monitorar as alterações na impressora ou no servidor de impressão.
FindNextPrinterChangeNotification	A função FindNextPrinterChangeNotification recupera informações sobre a notificação de alteração mais recente para um objeto de notificação de alteração associado a uma impressora ou servidor de impressão. Chame essa função quando uma operação de espera no objeto de notificação de alteração for atendida.
FreePrinterNotifyInfo	A função FreePrinterNotifyInfo libera um buffer alocado pelo sistema criado pela função FindNextPrinterChangeNotification .

Funções de formulário de impressora

Essas funções gerenciam os formulários usados por uma impressora.

Função	Descrição
AddForm	A função AddForm adiciona um formulário à lista de formulários disponíveis que podem ser selecionados para a impressora especificada.
DeleteForm	A função DeleteForm remove um nome de formulário da lista de formulários com suporte.
EnumForms	A função EnumForms enumera os formulários compatíveis com a impressora especificada.
GetForm	A função GetForm recupera informações sobre um formulário especificado.
SetForm	A função SetForm define as informações do formulário para a impressora especificada.

Funções de spooler de impressão

Essas funções interagem com o spooler de impressão em um nível baixo.

Função	Descrição
CloseSpoolFileHandle	A função CloseSpoolFileHandle fecha um identificador para um arquivo de spool associado ao trabalho de impressão enviado atualmente pelo aplicativo.
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.
GetPrintExecutionData	O GetPrintExecutionData recupera o contexto de impressão atual.
GetSpoolFileHandle	A função GetSpoolFileHandle recupera um identificador para o arquivo de spool associado ao trabalho enviado atualmente pelo aplicativo.

Compartilhar via