Método IPrintOemUni::CommandCallback (prcomoem.h)

Artigo
02/07/2025

O método IPrintOemUni::CommandCallback é usado para fornecer comandos de impressora gerados dinamicamente para impressoras com suporte unidrv.

Sintaxe

HRESULT CommandCallback(
        PDEVOBJ pdevobj,
        DWORD   dwCallbackID,
        DWORD   dwCount,
        PDWORD  pdwParams,
  [out] OUT INT *piResult
);

Parâmetros

pdevobj

Ponteiro fornecido pelo chamador para uma estrutura de DEVOBJ.

dwCallbackID

Valor fornecido pelo chamador que representa o atributo *CallbackID do comando da impressora no arquivo GPD da impressora. (Para obter mais informações, consulte a seção Comentários a seguir.)

dwCount

Valor fornecido pelo chamador que representa o número de elementos na matriz apontada por pdwParams. Pode ser 0.

pdwParams

Ponteiro fornecido pelo chamador para uma matriz de parâmetros do tamanho de DWORD que contêm valores especificados pelos comandos da impressora *params atributo no arquivo GPD da impressora. (Para obter mais informações, consulte a seção Comentários a seguir.) Pode ser NULL.

[out] piResult

Recebe um valor de resultado fornecido pelo método. Consulte a seção Comentários a seguir.

Valor de retorno

O método deve retornar um dos valores a seguir.

Código de retorno	Descrição
S_OK	A operação foi bem-sucedida.
E_FAIL	Falha na operação
E_NOTIMPL	O método não é implementado.

Observações

O método IPrintOemUni::CommandCallback é usado pela renderização de plug-ins para gerar comandos de impressora dinamicamente para impressoras compatíveis com Unidrv.

Se você quiser gerar dinamicamente um comando de impressora, deverá incluir um atributo *CallbackID e, opcionalmente, um atributo *Params, dentro da entrada *Command do comando no arquivo GPD da impressora. Para obter mais informações, consulte comandos de impressora gerados dinamicamente.

Quando o Unidrv chama o método IPrintOemUni::CommandCallback, ele fornece o valor do atributocallbackID da *entrada de comando como o parâmetro dwCallbackID. Ele também coloca o valor do atributo *Command entry's *Params dentro de uma matriz DWORD e fornece o endereço da matriz como o parâmetro pParams. A matriz contém um conjunto de variáveis padrão definidas por Unidrv valores e o parâmetro dwCount especifica o número de parâmetros contidos na matriz. Para obter mais informações sobre os atributos, consulte atributos de comando.

O método deve usar o dwCallbackID valor do parâmetro para determinar qual comando processar. Para cada comando com suporte, o método deve estar ciente de quais variáveis padrão foram especificadas pelo atributo *Command entry's *Params e em qual ordem.

O método é responsável por construir um comando de impressora e, em seguida, enviar o comando para o spooler de impressão chamando o método IPrintOemDriverUni::D rvWriteSpoolBuf.

O valor fornecido para piResult sempre deve retornar zero, a menos que o método esteja processando um comando de cursor. Para comandos de cursor que movem o cursor na direção x ou , o método deve retornar a nova posição do cursor.

O método IPrintOemUni::CommandCallback é opcional. Se um plug-in de renderização implementar esse método, o método IPrintOemUni::GetImplementedMethod método deverá retornar S_OK quando receber "CommandCallback" como entrada.

Requisitos

Requisito	Valor
da Plataforma de Destino	Área de trabalho
cabeçalho	prcomoem.h (inclua Prcomoem.h)

Partilhar via