Estrutura CPSUICBPARAM (compstui.h)

Artigo
07/16/2024

A estrutura CPSUICBPARAM é usada como o parâmetro de entrada para _CPSUICALLBACKfunções de retorno de chamada tipada.

Sintaxe

typedef struct _CPSUICBPARAM {
  WORD      cbSize;
  WORD      Reason;
  HWND      hDlg;
  POPTITEM  pOptItem;
  WORD      cOptItem;
  WORD      Flags;
  POPTITEM  pCurItem;
  union {
    LONG   OldSel;
    LPTSTR pOldSel;
  } DUMMYUNIONNAME;
  ULONG_PTR UserData;
  ULONG_PTR Result;
} CPSUICBPARAM, *PCPSUICBPARAM;

Membros

cbSize

Tamanho fornecido por CPSUI, em bytes, da estrutura CPSUICBPARAM.

Reason

Valor fornecido por CPSUI indicando o motivo pelo qual ele está chamando a função de retorno de chamada. Esse pode ser um dos seguintes valores:

CPSUICB_REASON_ABOUT

O usuário clicou no botão Sobre da página e o aplicativo definiu anteriormente o sinalizador CPSUIF_ABOUT_CALLBACK em uma estrutura de COMPROPSHEETUI . O CPSUI define pCurItem para o valor contido em pOptItem e define pOldSel para apontar para a estrutura de COMPROPSHEETUI .

CPSUICB_REASON_APPLYNOW

O usuário clicou no botão Aplicar ou OK da página e o CPSUI recebeu uma mensagem de notificação PSN_APPLY. O CPSUI define pCurItem para apontar para a opção para a qual pOptItem pontos. Ele também define OldSel como menos um para indicar que todos os valores de opção alterados válidos devem ser aplicados agora.

CPSUICB_REASON_DLGPROC

A opção identificada por pCurItem é um botão de push (TVOT_PUSHBUTTON tipo de opção) e o usuário clicou no botão.

O campo de Estilo de OPTPARAM da opção de botão de push está definido como PUSHBUTTON_TYPE_DLGPROC.

CPSUICB_REASON_ECB_CHANGED

A opção identificada por pCurItem é uma caixa de seleção estendida e o usuário alterou o estado da caixa.

CPSUICB_REASON_EXTPUSH

A opção identificada por pCurItem é um botão de push estendido e o usuário clicou no botão.

CPSUICB_REASON_ITEMS_REVERTED

O usuário clicou no botão desfazer do da página e o CPSUI reverteu todas as seleções para seus valores originais.

CPSUICB_REASON_KILLACTIVE

A página da folha de propriedades está prestes a perder a ativação e o CPSUI recebeu uma mensagem de notificação PSN_KILLACTIVE. O CPSUI define pCurItem para o valor contido em pOptItem e define pOldSel para apontar para a estrutura de COMPROPSHEETUI .

CPSUICB_REASON_OPTITEM_SETFOCUS

A opção identificada por pCurItem recebeu o foco de entrada.

CPSUICB_REASON_PUSHBUTTON

A opção identificada por pCurItem é um botão de push (TVOT_PUSHBUTTON tipo de opção) e o usuário clicou no botão.

O campo de EstiloOPTPARAM do item de push está definido como PUSHBUTTON_TYPE_CALLBACK.

CPSUICB_REASON_SEL_CHANGED

O usuário alterou o valor selecionado para a opção apontada por pCurItem.

CPSUICB_REASON_SETACTIVE

A página da folha de propriedades está prestes a se tornar ativa e o CPSUI recebeu uma mensagem de notificação PSN_SETACTIVE. O CPSUI define pCurItem para o valor contido em pOptItem e define pOldSel para apontar para a estrutura de COMPROPSHEETUI .

hDlg

Identificador fornecido por CPSUI para a caixa de diálogo ativa no momento.

pOptItem

Ponteiro fornecido por CPSUI para uma matriz de estruturas OPTITEM . Esse é o mesmo ponteiro que o aplicativo forneceu anteriormente em uma estrutura de COMPROPSHEETUI .

cOptItem

Número fornecido por CPSUI de estruturas OPTITEM na matriz apontada por pOptItem. Esse é o mesmo número fornecido anteriormente pelo aplicativo em uma estrutura de COMPROPSHEETUI .

Flags

Sinalizadores fornecidos por CPSUI. Esse é o mesmo conjunto de sinalizadores fornecidos anteriormente pelo aplicativo em uma estrutura de COMPROPSHEETUI .

pCurItem

Ponteiro fornecido por CPSUI para um membro da matriz OPTITEM apontado por pOptItem. Esse membro de matriz representa a opção "atual", que é aquela para a qual a função de retorno de chamada foi chamada.

DUMMYUNIONNAME

Define a união DUMMYUNIONNAME.

DUMMYUNIONNAME.OldSel

Se o membro Reason contiver CPSUICB_REASON_SEL_CHANGED, o CPSUI definirá essa união para o conteúdo anterior do membro/pOldSel do OPTITEM apontado por pCurItem.

Para todos os outros valores Reason, o conteúdo dessa união deve ser ignorado.

DUMMYUNIONNAME.pOldSel

Se o membro Reason contiver CPSUICB_REASON_SEL_CHANGED, o CPSUI definirá essa união para o conteúdo anterior do membro/pOldSel do OPTITEM apontado por pCurItem.

Para todos os outros valores Reason, o conteúdo dessa união deve ser ignorado.

UserData

Dados de usuário fornecidos pelo CPSUI. Esse é o mesmo valor fornecido anteriormente pelo aplicativo em uma estrutura de COMPROPSHEETUI .

Result

Valor de resultado fornecido pela função de retorno de chamada digitada _CPSUICALLBACK. Por padrão, o CPSUI define esse valor como CPSUI_OK. Depois que a função de retorno de chamada retorna, o CPSUI chama sua função ComPropSheet com um código de função de CPSFUNC_SET_RESULT, fornecendo o conteúdo do membro Reason como o valor do resultado.

Esse membro será usado somente se o membro motivo estiver CPSUICB_REASON_APPLYNOW e a função de retorno de chamada não retornar CPSUI_ACTION_NO_APPLY_EXIT.

Requisitos

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

Compartilhar via