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

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 trabalhos de impressão que ele controla.

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

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

Funções de trabalho de impressão

Estas funções enviam trabalhos de impressão para uma impressora e controlam 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çãoDocumentProperties recupera ou modifica informações de inicialização da impressora ou exibe uma folha de propriedades de configuração da impressora para a impressora especificada.
EndDocPrinter	A função EndDocPrinter termina um trabalho de impressão para a impressora especificada.
EndPagePrinter	A funçãoEndPagePrinter 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 alças no subsistema de impressão.
OpenPrinter2	Recupera um identificador para a impressora especificada, servidor de impressão ou outros tipos de alças no subsistema de impressão, enquanto define algumas das opções da impressora.
ReportJobProcessingProgress	Informa ao serviço Spooler de Impressão se um trabalho de impressão XPS está na fase de spooling ou renderização e qual parte do processamento está atualmente em andamento.
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çãoStartDocPrinter notifica o spooler de impressão de que um documento deve ser colocado em spool para impressão.
StartPagePrinter	A funçãoStartPagePrinter notifica o spooler de que uma página está prestes a ser impressa na impressora especificada.

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

Essas funções exibem uma interface de usuário que permite ao usuário selecionar ou configurar uma impressora.

Função	Descrição
AdvancedDocumentProperties	A funçãoAdvancedDocumentProperties 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çãoConfigurePort exibe a caixa de diálogo de configuração de porta para uma porta no servidor especificado.
ConnectToPrinterDlg	A funçãoConnectToPrinterDlg 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 seleciona uma impressora, a função tenta criar uma conexão com ela; Se um driver adequado não estiver instalado no servidor, o usuário terá a opção de criar uma impressora localmente.
PrinterProperties	A funçãoPrinterProperties exibe uma folha de propriedades da impressora para a impressora especificada.

Funções da impressora

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

Função	Descrição
AbortPrinter	A função AbortPrinter exclui 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 suportadas 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 os detalhes da conexão.
DeletePrinter	A funçãoDeletePrinter exclui o objeto de impressora especificado.
DeletePrinterConnection	A funçãoDeletePrinterConnection 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 digitados. A função DeletePrinterData exclui um desses valores, especificado por seu nome de valor.
DeletePrinterDataEx	A funçãoDeletePrinterDataEx 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 digitados armazenados em uma hierarquia de chaves do Registro. A função exclui um valor especificado sob uma chave especificada.
DeletePrinterKey	A função DeletePrinterKey exclui uma chave especificada e todas as suas subchaves para uma impressora especificada.
EnumPrinterData	A função EnumPrinterData enumera dados de configuração para uma impressora especificada.
EnumPrinterDataEx	A funçãoEnumPrinterDataEx enumera todos os nomes de valor e dados para uma impressora e chave especificadas.
EnumPrinterKey	A funçãoEnumPrinterKey enumera as subchaves de uma chave especificada para uma impressora especificada.
EnumPrinters	A funçãoEnumPrinters enumera impressoras, servidores de impressão, domínios ou provedores de impressão disponíveis.
FlushPrinter	A função FlushPrinter envia um buffer para a impressora para limpá-la 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çãoGetPrinterDataExrecupera dados de configuração para a impressora ou servidor de impressão especificado. GetPrinterDataEx pode recuperar valores armazenados pelo função SetPrinterData. Além disso, GetPrinterDataEx pode recuperar valores armazenados sob uma chave especificada pela funçãoSetPrinterDataEx.
IsValidDevmode	A funçãoIsValidDevmode verifica se o conteúdo de uma estrutura DEVMODE é válido.
ReadPrinter	A função ReadPrinter recupera dados da impressora especificada.
ResetPrinter	A funçãoResetPrinter especifica o tipo de dados e os valores de modo de dispositivo a serem usados para imprimir documentos enviados pela funçãoStartDocPrinter. 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 para uma impressora ou servidor de impressão.
SetPrinterDataEx	A função SetPrinterDataEx define os dados de configuração para uma impressora ou servidor de impressão. A função armazena os dados de configuração sob a chave de registo 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çãoFindClosePrinterChangeNotification fecha um objeto de notificação de alteração criado chamando a funçãoFindFirstPrinterChangeNotification. 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çãoFindFirstPrinterChangeNotification 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çãoFindNextPrinterChangeNotification 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 satisfeita.
FreePrinterNotifyInfo	A funçãoFreePrinterNotifyInfo libera um buffer alocado pelo sistema criado pela funçãoFindNextPrinterChangeNotification.

Funções de formulário da 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çãoDeleteForm remove um nome de formulário da lista de formulários suportados.
EnumForms	A funçãoEnumForms enumera os formulários suportados pela impressora especificada.
GetForm	O função GetForm recupera informações sobre um formulário especificado.
SetForm	A função SetForm define as informações de formulário para a impressora especificada.

Funções do 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çãoCloseSpoolFileHandle fecha um identificador para um arquivo de spool associado ao trabalho de impressão atualmente enviado 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	O função GetSpoolFileHandle recupera um identificador para o arquivo de spool associado ao trabalho atualmente enviado pelo aplicativo.