Função DrvDocumentPropertySheets (winddiui.h)

A função DrvDocumentPropertySheets de uma interface de impressora é responsável por criar páginas de folha de propriedades que descrevem as propriedades de um documento de impressão.

Sintaxe

LONG DrvDocumentPropertySheets(
  [in, optional] PPROPSHEETUI_INFO pPSUIInfo,
                 LPARAM            lParam
);

Parâmetros

[in, optional] pPSUIInfo

Ponteiro fornecido pelo chamador para uma estrutura de PROPSHEETUI_INFO . Pode ser NULL (consulte a seção Comentários a seguir).

lParam

Valor inteiro fornecido pelo chamador que depende do conteúdo do membro Reason da estrutura PROPSHEETUI_INFO, conforme listado na tabela a seguir.

Valor do motivo Definição de lParam
PROPSHEETUI_REASON_INIT Ponteiro para uma estrutura DOCUMENTPROPERTYHEADER .
Todos os outros valores de motivo Consulte a descrição do parâmetro lParam para o tipo de função PFNPROPSHEETUI . (O endereço da estrutura DOCUMENTPROPERTYHEADER está contido no membro lParamInit da estrutura PROPSHEETUI_INFO .)

Retornar valor

Se pPSUIInfo for NULL e se lParam ->fMode for zero ou lParam ->pdmOut for NULL, essa função deverá retornar o tamanho, em bytes, da estrutura DEVMODEW da impressora. Caso contrário, o valor retornado da função será o mesmo descrito na seção ReturnValue do tipo de função PFNPROPSHEETUI . Para obter mais informações, consulte a seção Comentários.

Comentários

Todas as DLLs da interface da impressora devem fornecer uma função DrvDocumentPropertySheets , que é definida usando o tipo de função PFNPROPSHEETUI . A finalidade da função é chamar a função ComPropSheet , fornecida pelo CPSUI, para especificar páginas de folha de propriedades que contêm propriedades modificáveis pelo usuário para documentos de impressão.

Se o valor recebido para o parâmetro pPSUIInfo não for NULL, o spooler de impressão do sistema operacional baseado em NT chamará a função indiretamente por meio do CPSUI. As seguintes regras se aplicam:

  • A função deve executar operações conforme descrito para o tipo de função PFNPROPSHEETUI .

  • Sinalizadores no membro fMode da estrutura DOCUMENTPROPERTYHEADER indicam quais páginas de folha de propriedades exibir e se o usuário deve ter permissão para modificar as propriedades de um documento. Os únicos sinalizadores que podem ser definidos são DM_IN_PROMPT (ou DM_PROMPT), DM_ADVANCED, DM_NOPERMISSION e DM_OUT_BUFFER (ou DM_COPY).

Se o valor recebido para o parâmetro pPSUIInfo for NULL, o spooler de impressão chamará a função diretamente, sem passar pelo CPSUI. Nesse caso, o parâmetro lParam contém o endereço de uma estrutura DOCUMENTPROPERTYHEADER e as seguintes regras se aplicam:

  • Se o membro fMode da estrutura DOCUMENTPROPERTYHEADER for zero ou se o membro pdmOut da mesma estrutura for NULL, a função deverá retornar apenas o tamanho total da estrutura DEVMODEW da impressora, incluindo membros de estrutura pública e privada, no membro cbOut da estrutura DOCUMENTPROPERTYHEADER.

  • Se o membro fMode da estrutura DOCUMENTPROPERTYHEADER não for zero, a função deverá executar as operações indicadas pelos sinalizadores fMode . Os únicos sinalizadores que podem ser definidos são DM_IN_BUFFER (ou DM_MODIFY) e DM_OUT_BUFFER (ou DM_COPY).

Requisitos

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

Confira também

DOCUMENTPROPERTYHEADER

DrvDevicePropertySheets

IPrintOemUI::D ocumentPropertySheets