Compartilhar via


_CPSUICALLBACK função de retorno de chamada (compstui.h)

O tipo de função _CPSUICALLBACK é usado por aplicativos CPSUI (incluindo DLLs de interface da impressora) para definir uma função de retorno de chamada destinada a ser usada como um manipulador de mensagens CPSUI.

Sintaxe

_CPSUICALLBACK Cpsuicallback;

LONG Cpsuicallback(
  PCPSUICBPARAM pCPSUICBParam
)
{...}

Parâmetros

pCPSUICBParam

Ponteiro fornecido por CPSUI para uma estrutura CPSUICBPARAM .

Retornar valor

Uma função de retorno de chamada do tipo _CPSUICALLBACK deve retornar um dos valores listados na tabela a seguir. Cada valor indica uma ação que o CPSUI deve executar.

Código de retorno Descrição
CPSUICB_ACTION_ITEMS_APPLIED O membro Reason da estrutura CPSUICBPARAM foi definido como CPSUICB_REASON_APPLYNOW e a função de retorno de chamada processou com êxito os valores de opção atuais.
CPSUICB_ACTION_NO_APPLY_EXIT O membro Reason da estrutura CPSUICBPARAM foi definido como CPSUICB_REASON_APPLYNOW, mas a função de retorno de chamada detectou valores de opção inválidos ou incompatíveis. A função de retorno de chamada deve exibir uma caixa de diálogo informando ao usuário sobre o problema.
CPSUICB_ACTION_NONE Nenhuma ação do CPSUI é necessária.
CPSUICB_ACTION_OPTIF_CHANGED A função de retorno de chamada definiu o sinalizador OPTIF_CHANGED em uma estrutura OPTITEM para indicar que a opção selecionada foi alterada ou que outro sinalizador prefixado por OPTIF foi alterado.
CPSUICB_ACTION_REINIT_ITEMS A função de retorno de chamada definiu o sinalizador OPTIF_CHANGED em uma estrutura OPTITEM para indicar que sinalizadores ou membros pData da estrutura OPTTYPE ou OPTPARAM associada foram alterados.

Comentários

As funções de retorno de chamada especificadas usando o tipo de função _CPSUICALLBACK são fornecidas por aplicativos que usam CPSUI para gerenciar páginas de folha de propriedades. Se uma dessas funções de retorno de chamada estiver associada a uma página de folha de propriedades, a CPSUI a chamará quando a atividade do usuário (como alterar o foco de controle da página, modificar valores de opção ou clicar em OK) for detectada.

Uma função de retorno de chamada do tipo _CPSUICALLBACK é atribuída a uma página de folha de propriedades, incluindo seu endereço em uma estrutura COMPROPSHEETUI , que é passada para a função ComPropSheet do CPSUI quando o código de função é CPSFUNC_ADD_PCOMPROPSHEETUI.

Além disso, as funções de retorno de chamada podem ser atribuídas a botões de push estendidos por meio do uso de estruturas EXTPUSH .

Quando uma dessas funções de retorno de chamada é chamada, ela recebe um ponteiro para uma estrutura CPSUICBPARAM . Essa estrutura descreve as configurações de opção atuais da página e indica o evento do usuário que fez com que a função fosse chamada. A função de retorno de chamada é responsável por validar e processar as configurações. Ele deverá exibir uma caixa de diálogo se uma configuração (ou uma combinação de configurações) for inválida. O valor retornado da função indica ao CPSUI se a página precisa ser reproduzida ou reinicializada.

As funções de retorno de chamada especificadas com esse tipo de função não poderão ser usadas se o membro DlgProc da estrutura DLGPAGE especificar um procedimento de caixa de diálogo fornecido pelo aplicativo. Isso ocorre porque os retornos de chamada do tipo _CPSUICALLBACK são chamados dos procedimentos da caixa de diálogo do CPSUI, que não são usados se o aplicativo fornece seus próprios procedimentos.

Requisitos

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