Função CommonPropertySheetUIA (compstui.h)

A função CommonPropertySheetUI do CPSUI exibe páginas de folha de propriedades e permite que as modificações do usuário exibam valores.

Sintaxe

LONG CommonPropertySheetUIA(
  HWND           hWndOwner,
  PFNPROPSHEETUI pfnPropSheetUI,
  LPARAM         lParam,
  LPDWORD        pResult
);

Parâmetros

hWndOwner

Identificador de janela fornecido pelo chamador que identifica a janela na qual novas páginas da folha de propriedades devem ser colocadas.

pfnPropSheetUI

Ponteiro fornecido pelo chamador para uma função de retorno de chamada do tipo PFNPROPSHEETUI.

lParam

Valor fornecido pelo chamador que é usado como um argumento de entrada para a função pfnPropSheetUI . Esse valor pode ser um ponteiro.

pResult

Ponteiro fornecido pelo chamador para um DWORD que recebe o retorno final da função pfnPropSheetUI status. Se FOR NULL, o retorno final status não será retornado. Para obter mais informações, consulte a seção Comentários a seguir.

Retornar valor

A função CommonPropertySheetUI retorna um dos seguintes valores:

Código de retorno	Descrição
CPSUI_CANCEL	A função pfnPropSheetUI retornou um valor negativo.
CPSUI_OK	A operação foi realizada com êxito.
CPSUI_REBOOTSYSTEM	A operação foi bem-sucedida e um procedimento de caixa de diálogo enviou a mensagem PSM_REBOOTSYSTEM .
CPSUI_RESTARTWINDOWS	A operação foi bem-sucedida e um procedimento de caixa de diálogo enviou a mensagem PSM_RESTARTWINDOWS .
código de erro prefixado por ERR_CPSUI	Ocorreu uma falha. Os códigos de erro prefixados por ERR_CPSUI são definidos em compstui.h.

Comentários

A função CommonPropertySheetUI é o ponto de entrada do CPSUI para aplicativos. Um aplicativo CPSUI (como o spooler de impressão do sistema operacional baseado em Microsoft NT) pode chamar a função para adicionar uma ou mais páginas de folha de propriedades a uma janela pai predefinida. O CPSUI exibe as páginas, permite que o usuário as modifique e notifica a aplicação da atividade do usuário por meio de funções de retorno de chamada.

O spooler de impressão do sistema operacional baseado em NT chama a função CommonPropertySheetUI quando um aplicativo Win32 chama as funções DocumentProperties ou PrinterProperties do spooler.

A função de retorno de chamada especificada pelo parâmetro pfnPropSheetUI é responsável por descrever as páginas da folha de propriedades a serem adicionadas. Para obter mais informações, consulte a descrição do tipo de função PFNPROPSHEETUI .

A sequência de operação é a seguinte:

1. A função CommonPropertySheetUI chama o retorno de chamada pfnPropSheetUI para que o retorno de chamada possa descrever as páginas a serem adicionadas chamando a função ComPropSheet do CPSUI.

2. Se o retorno de chamada pfnPropSheetUI for bem-sucedido, a função CommonPropertySheetUI exibirá as novas páginas da folha de propriedades e permitirá que o usuário modifique os valores da página.

3. Se o usuário modificar valores de página, um retorno de chamada de evento de página notificará o aplicativo das alterações.

4. Quando o usuário escolhe o botão OK ou Cancelar , a função CommonPropertySheetUI destrói as páginas exibidas e retorna.

Para obter mais informações sobre a sequência de operação, consulte Usando CPSUI com drivers de impressora, na seção intitulada CPSUI.

A função CommonPropertySheetUI realmente chama o retorno de chamada pfnPropSheetUI várias vezes, especificando valores de membro Reason diferentes na estrutura PROPSHEETUI_INFO do retorno de chamada. Cada vez que o retorno de chamada é retornado, ele coloca um resultado status no membro Resultado da estrutura PROPSHEETUI_INFO. Quando a função CommonPropertySheetUI retorna, ela copia o conteúdo final de Result para o local apontado por pResult.

Requisitos

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