Structure CPSUICBPARAM (compstui.h)

La structure CPSUICBPARAM est utilisée comme paramètre d’entrée pour _CPSUICALLBACKfonctions de rappel typées.

Syntaxe

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;

Membres

cbSize

Taille fournie par CPSUI, en octets, de la structure CPSUICBPARAM.

Reason

Valeur fournie par CPSUI indiquant la raison pour laquelle elle appelle la fonction de rappel. Il peut s’agir de l’une des valeurs suivantes :

CPSUICB_REASON_ABOUT

L’utilisateur a cliqué sur le bouton About de la page et l’application a précédemment défini l’indicateur CPSUIF_ABOUT_CALLBACK dans une structure COMPROPSHEETUI. CPSUI définit pCurItem à la valeur contenue dans pOptItem et définit pOldSel pour pointer vers la structure COMPROPSHEETUI.

CPSUICB_REASON_APPLYNOW

L’utilisateur a cliqué sur l'Appliquer ou bouton OK, et CPSUI a reçu un message de notification PSN_APPLY. CPSUI définit pCurItem pour pointer vers l’option à laquelle points pOptItem. Il définit également OldSel sur moins un pour indiquer que toutes les valeurs d’option modifiées valides doivent être appliquées maintenant.

CPSUICB_REASON_DLGPROC

L’option identifiée par pCurItem est un bouton push (TVOT_PUSHBUTTON type d’option) et l’utilisateur a cliqué sur le bouton.

Le champ style de l’option OPTPARAM de l’option de bouton push est défini sur PUSHBUTTON_TYPE_DLGPROC.

CPSUICB_REASON_ECB_CHANGED

L’option identifiée par pCurItem est une case à cocher étendue et l’utilisateur a modifié l’état de la zone.

CPSUICB_REASON_EXTPUSH

L’option identifiée par pCurItem est un bouton push étendu, et l’utilisateur a cliqué sur le bouton.

CPSUICB_REASON_ITEMS_REVERTED

L’utilisateur a cliqué sur le bouton Annuler de la page, et CPSUI a rétabli toutes les sélections à leurs valeurs d’origine.

CPSUICB_REASON_KILLACTIVE

La page de la feuille de propriétés est sur le point de perdre l’activation et CPSUI a reçu un message de notification PSN_KILLACTIVE. CPSUI définit pCurItem à la valeur contenue dans pOptItem et définit pOldSel pour pointer vers la structure COMPROPSHEETUI .

CPSUICB_REASON_OPTITEM_SETFOCUS

L’option identifiée par pCurItem a reçu le focus d’entrée.

CPSUICB_REASON_PUSHBUTTON

L’option identifiée par pCurItem est un bouton push (TVOT_PUSHBUTTON type d’option) et l’utilisateur a cliqué sur le bouton.

Le champ style de l’élément de bouton push est défini sur PUSHBUTTON_TYPE_CALLBACK.

CPSUICB_REASON_SEL_CHANGED

L’utilisateur a modifié la valeur sélectionnée pour l’option pointée par pCurItem.

CPSUICB_REASON_SETACTIVE

La page de la feuille de propriétés est sur le point de devenir active et CPSUI a reçu un message de notification PSN_SETACTIVE. CPSUI définit pCurItem à la valeur contenue dans pOptItem et définit pOldSel pour pointer vers la structure COMPROPSHEETUI .

hDlg

Handle fourni par CPSUI dans la boîte de dialogue actuellement active.

pOptItem

Pointeur fourni par CPSUI vers un tableau de structures OPTITEM . Il s’agit du même pointeur que l’application précédemment fournie dans une structure COMPROPSHEETUI.

cOptItem

Nombre de structures OPTITEM fournies par CPSUI dans le tableau pointé par pOptItem. Il s’agit du même nombre que l’application précédemment fournie dans une structure COMPROPSHEETUI.

Flags

Indicateurs fournis par CPSUI. Il s’agit du même jeu d’indicateurs que l’application précédemment fournie dans une structure COMPROPSHEETUI.

pCurItem

Pointeur fourni par CPSUI vers un membre du tableau OPTITEM pointé par pOptItem. Ce membre de tableau représente l’option « actuelle », qui est celle pour laquelle la fonction de rappel a été appelée.

DUMMYUNIONNAME

Définit l’union DUMMYUNIONNAME.

DUMMYUNIONNAME.OldSel

Si le membre motif de contient CPSUICB_REASON_SEL_CHANGED, CPSUI définit cette union sur le contenu précédent du membre oldSelpOld Sel de la structure OPTITEM pointée par pCurItem.

Pour toutes les autres valeurs Motif, le contenu de cette union doit être ignoré.

DUMMYUNIONNAME.pOldSel

Si le membre motif de contient CPSUICB_REASON_SEL_CHANGED, CPSUI définit cette union sur le contenu précédent du membre oldSelpOld Sel de la structure OPTITEM pointée par pCurItem.

Pour toutes les autres valeurs Motif, le contenu de cette union doit être ignoré.

UserData

Données utilisateur fournies par CPSUI. Il s’agit de la même valeur que celle fournie précédemment dans une structure COMPROPSHEETUI.

Result

Valeur de résultat fournie par la fonction de rappel _CPSUICALLBACK-typée. Par défaut, CPSUI définit cette valeur sur CPSUI_OK. Une fois la fonction de rappel retournée, CPSUI appelle sa fonction ComPropSheet avec un code de fonction de CPSFUNC_SET_RESULT, en fournissant le contenu Motif membre comme valeur de résultat.

Ce membre est utilisé uniquement si le membre Reason est CPSUICB_REASON_APPLYNOW et que la fonction de rappel ne retourne pas CPSUI_ACTION_NO_APPLY_EXIT.

Exigences