Método IPrintOemUI::CommonUIProp (prcomoem.h)

O IPrintOemUI::CommonUIProp método permite que um plug-in de interface do usuário modifique uma página de folha de propriedades de impressora existente.

Sintaxe

HRESULT CommonUIProp(
  DWORD         dwMode,
  POEMCUIPPARAM pOemCUIPParam
);

Parâmetros

dwMode

Constante de inteiro fornecida pelo chamador indicando qual página da folha de propriedades deve ser modificada. As constantes a seguir são válidas.

Valor	Definição
OEMCUIP_DOCPROP	O método está sendo chamado para modificar a página Layout, Papel/Qualidade ou Avançado da folha de propriedades do documento.
OEMCUIP_PRNPROP	O método está sendo chamado para modificar a página Configurações do Dispositivo da folha de propriedades da impressora.

pOemCUIPParam

Ponteiro fornecido pelo chamador para uma estrutura OEMCUIPPARAM .

Retornar valor

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

Código de retorno	Descrição
S_OK	A operação foi realizada com êxito.
E_FAIL	Falha na operação.
E_NOTIMPL	O método não está implementado.

Comentários

Quando o método de um plug-in de interface do IPrintOemUI::CommonUIProp usuário é chamado, ele deve retornar itens de opção de folha de propriedades personalizados para modificar uma página de folha de propriedades de impressora existente.

O IPrintOemUI::CommonUIProp método é chamado pela DLL da interface da impressora do driver de impressora. O método deve fornecer uma matriz de estruturas OPTITEM que descrevem itens de folha de propriedades, juntamente com uma função de retorno de chamada para processar modificações do usuário em valores de opção.

Você deve esperar que o método seja chamado duas vezes para cada folha de propriedades. O valor do parâmetro dwMode do método indica se ele está sendo chamado para fazer alterações na folha de propriedades da impressora ou na folha de propriedades do documento.

Na primeira vez que for chamado, o método deve retornar apenas o número de estruturas OPTITEM a serem adicionadas. Esse número deve ser colocado no membro cOEMOptItems da estrutura OEMCUIPPARAM. A DLL da interface da impressora aloca memória suficiente para armazenar o número especificado de OPTITEMs e chamadas IPrintOemUI::CommonUIProp novamente.

Na segunda vez em que for chamado, o IPrintOemUI::CommonUIProp método deve fazer o seguinte:

• Preencha a matriz fornecida pelo driver de estruturas OPTITEM com descrições de opção. Essa matriz é apontada pelo membro pOEMOptItems da estrutura OEMCUIPPARAM e o número de elementos de matriz alocados está contido no membro cOEMOptItems da estrutura. (Para obter informações sobre como especificar valores de membro OPTITEM, consulte a descrição do membro pOEMOptItems da estrutura OEMCUIPPARAM).
• Retorne o número de estruturas adicionadas à matriz OPTITEM colocando o número no membro cOEMOptItems da estrutura OEMCUIPPARAM.
• Retornar o endereço de uma função de retorno de chamada no membro OEMCUIPPARAM da estrutura OEMCUIPCallback . Essa função de retorno de chamada é chamada quando um usuário modifica a página da folha de propriedades. A função de retorno de chamada deve ser do tipo OEMCUIPCALLBACK.
• Opcionalmente, retorne o endereço de uma estrutura de dados privada colocando-o no membro pOEMUserData da estrutura OEMCUIPPARAM. A função de retorno de chamada especificada pelo membro OEMCUIPCallback da estrutura recebe o endereço da estrutura OEMCUIPPARAM como um parâmetro de entrada e, portanto, pode obter o endereço dos dados privados.

  O espaço para a estrutura de dados privados deve ser alocado chamando o SDK do Microsoft Windows função HeapAlloc, usando o identificador contido no membro hOEMHeap da estrutura OEMCUIPPARAM.

Se IPrintOemUI::CommonUIProp os métodos forem exportados por vários plug-ins de interface do usuário, os métodos serão chamados na ordem em que os plug-ins são especificados para instalação.

Para obter mais informações, consulte Modificando uma página de folha de propriedades Driver-Supplied.

Requisitos

Requisito	Valor
Plataforma de Destino	Área de Trabalho
Cabeçalho	prcomoem.h (inclua Prcomoem.h)