Estrutura COMPROPSHEETUI (compstui.h)

Artigo
02/22/2024

A estrutura COMPROPSHEETUI será usada como um parâmetro de entrada para a função ComPropSheet do CPSUI, se o código da função for CPSFUNC_ADD_PCOMPROPSHEETUI. Todos os membros da estrutura devem ser fornecidos pelo chamador do ComPropSheet.

Sintaxe

typedef struct _COMPROPSHEETUI {
  WORD           cbSize;
  WORD           Flags;
  HINSTANCE      hInstCaller;
  LPTSTR         pCallerName;
  ULONG_PTR      UserData;
  LPTSTR         pHelpFile;
  _CPSUICALLBACK pfnCallBack;
  POPTITEM       pOptItem;
  PDLGPAGE       pDlgPage;
  WORD           cOptItem;
  WORD           cDlgPage;
  ULONG_PTR      IconID;
  LPTSTR         pOptItemName;
  WORD           CallerVersion;
  WORD           OptItemVersion;
  ULONG_PTR      dwReserved[4];
} COMPROPSHEETUI, *PCOMPROPSHEETUI;

Membros

cbSize

Tamanho fornecido pelo chamador, em bytes, da estrutura COMPROPSHEETUI .

Flags

Sinalizadores de bits fornecidos pelo chamador opcionais, conforme descrito na lista a seguir:

CPSUIF_ABOUT_CALLBACK

Se definida, a função de retorno de chamada da página (apontada pelo membro pfnCallback da estrutura) dá suporte a CPSUICB_REASON_ABOUT, portanto, o CPSUI chamará a função de retorno de chamada se o usuário clicar no botão Sobre da página. (O CPSUI fornece um botão Sobre para cada nó raiz de visão de árvore.)

CPSUIF_ICONID_AS_HICON

Se definido, o membro IconID da estrutura conterá um identificador de ícone.

Se não estiver definido, o membro IconID conterá um identificador de recurso de ícone.

CPSUIF_UPDATE_PERMISSION

Se definido, os valores de opção da página podem ser modificados pelo usuário.

hInstCaller

Identificador de instância de módulo fornecido pelo chamador, recebido pela função de ponto de entrada da DLL.

pCallerName

Ponteiro fornecido pelo chamador para uma cadeia de caracteres de texto terminada em NULL que representa o nome do aplicativo. (Para uma DLL de interface de impressora, esse deve ser o nome do driver, como "Driver PostScript".)

UserData

Valor opcional fornecido pelo chamador, que o CPSUI coloca no membro UserData de uma estrutura CPSUICBPARAM ao chamar a função apontada por pfnCallBack.

pHelpFile

Ponteiro fornecido pelo chamador para uma cadeia de caracteres de texto terminada em NULL que representa um caminho para um arquivo de ajuda. Para DLLs de interface de impressora, esse normalmente é o caminho do arquivo de ajuda obtido chamando GetPrinterDriver.

O arquivo de ajuda é indexado por valores contidos no membro HelpIndex das estruturas OPTITEM .

pfnCallBack

Ponteiro fornecido pelo chamador para uma função de retorno de chamada do tipo _CPSUICALLBACK, que o CPSUI chama quando um usuário modifica os valores de opção da página.

Só poderá ser usado se pDlgPage identificar uma estrutura DLGPAGE fornecida por CPSUI ou se o membro DlgProc de uma estrutura DLGPAGE fornecida pelo aplicativo for NULL.

pOptItem

Ponteiro fornecido pelo chamador para uma matriz de estruturas OPTITEM que descrevem as opções da página.

pDlgPage

Esse membro especifica estruturas DLGPAGE que descrevem páginas a serem adicionadas à folha de propriedades. Pode ser uma das seguintes opções:

Um ponteiro para uma matriz de estruturas DLGPAGE.
Um dos ponteiros descritos na lista a seguir. Esses ponteiros fazem referência a estruturas DLGPAGE predefinidas, fornecidas pelo CPSUI para uso por DLLs de interface de impressora.
- CPSUI_PDLGPAGE_ADVDOCPROP
  
  Define uma página de visão de árvore cuja guia lê Avançado. Para uso somente por uma função DrvDocumentPropertySheets .
- CPSUI_PDLGPAGE_DOCPROP
  
  Define três páginas, cujas guias são Layout, Papel/Qualidade e Avançado. A página Avançado é um modo de exibição de árvore. Para uso somente por uma função DrvDocumentPropertySheets .
- CPSUI_PDLGPAGE_PRINTERPROP
  
  Define uma página de visão de árvore cuja guia lê Configurações do Dispositivo. Para uso somente por uma função DrvDevicePropertySheets .
- CPSUI_PDLGPAGE_TREEVIEWONLY
  
  Define uma página de visão de árvore.

cOptItem

Número fornecido pelo chamador de estruturas OPTITEM apontadas por pOptItem.

cDlgPage

Número fornecido pelo chamador de estruturas DLGPAGE apontadas por pDlgPage. Não usado se pDlgPage especificar uma estrutura predefinida CPSUI_PDLGPAGE prefixada.

IconID

Fornecido pelo chamador, pode ser um dos seguintes:

Um identificador de recurso de ícone. Isso pode ser definido pelo aplicativo ou pode ser um dos identificadores de recurso de ícone com prefixo IDI_CPSUI fornecidos por CPSUI.
Um identificador de ícone. Se um identificador for especificado, CPSUIF_ICONID_AS_HICON deverá ser definido no membro Flags .

O ícone especificado é exibido no nó raiz do modo de exibição de árvore da página da folha de propriedades.

pOptItemName

Ponteiro fornecido pelo chamador para uma cadeia de caracteres terminada em NULL a ser exibida no nó raiz do modo de exibição de árvore da página da folha de propriedades. Para DLLs de interface de impressora, essa cadeia de caracteres normalmente representa um tipo de dispositivo de impressora, como "HP 4si".

CallerVersion

Número de versão fornecido pelo chamador, representando a versão atual do aplicativo de chamada. O byte alto identifica a versão principal e o byte baixo é a versão secundária. Por exemplo, um valor callerVersion de 0x310 especifica um número de versão do chamador de 3.16. O número de versão é exibido quando um usuário clica no botão Sobre de uma página.

OptItemVersion

Número de versão fornecido pelo chamador, representando a versão atual do item de opção no nível raiz. Para DLLs de interface de impressora, isso normalmente representa uma versão do dispositivo de impressora. O byte alto identifica a versão principal e o byte baixo é a versão secundária. Por exemplo, um valor OptItemVersion de 0x3ff especifica um número de versão do chamador de 3.255. O número de versão é exibido quando um usuário clica no botão Sobre de uma página.

dwReserved[4]

Reservado. Essa matriz deve ser definida como zero.

Requisitos

Requisito	Valor
Cabeçalho	compstui.h (inclua Compstui.h)

Compartilhar via