CPSUICBPARAM 構造体 (compstui.h)

  • [アーティクル]

CPSUICBPARAM 構造体は、型指定されたコールバック関数を _CPSUICALLBACKするための入力パラメーターとして使用されます。

構文

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;

メンバー

cbSize

CPSUICBPARAM 構造体の CPSUI 提供のサイズ (バイト単位)。

Reason

コールバック関数を呼び出す理由を示す CPSUI 提供の値。 次のいずれかの値を指定できます。

CPSUICB_REASON_ABOUT

ユーザーがページの [バージョン 情報] ボタンをクリックすると、アプリケーションは以前に COMPROPSHEETUI 構造体で CPSUIF_ABOUT_CALLBACK フラグを設定しました。 CPSUI は pCurItem を pOptItem に含まれる値に設定し、 pOldSel をCOMPROPSHEETUI 構造体を指すように設定します。

CPSUICB_REASON_APPLYNOW

ユーザーがページの [適用 ] または [OK] ボタンを クリックすると、CPSUI に PSN_APPLY 通知メッセージが表示されます。 CPSUI は 、pOptItem が ポイントするオプションを指す pCurItem を 設定します。 また、 OldSel をマイナス 1 に設定して、すべての有効な変更されたオプション値を今すぐ適用する必要があることを示します。

CPSUICB_REASON_DLGPROC

pCurItem で識別されるオプションはプッシュ ボタン (オプションの種類TVOT_PUSHBUTTON) であり、ユーザーはそのボタンをクリックしました。

プッシュ ボタン オプションの OPTPARAM スタイル フィールドは、PUSHBUTTON_TYPE_DLGPROCに設定されています。

CPSUICB_REASON_ECB_CHANGED

pCurItem によって識別されるオプションは拡張チェック ボックスであり、ユーザーはボックスの状態を変更しました。

CPSUICB_REASON_EXTPUSH

pCurItem によって識別されるオプションは拡張プッシュ ボタンであり、ユーザーはそのボタンをクリックしました。

CPSUICB_REASON_ITEMS_REVERTED

ユーザーがページの [元に戻す ] ボタンをクリックすると、CPSUI によってすべての選択が元の値に戻されました。

CPSUICB_REASON_KILLACTIVE

プロパティ シート ページのアクティブ化が失われようとしており、CPSUI は PSN_KILLACTIVE 通知メッセージを受信しました。 CPSUI は pCurItem を pOptItem に含まれる値に設定し、 pOldSel をCOMPROPSHEETUI 構造体を指すように設定します。

CPSUICB_REASON_OPTITEM_SETFOCUS

pCurItem によって識別されるオプションは、入力フォーカスを受け取っています。

CPSUICB_REASON_PUSHBUTTON

pCurItem で識別されるオプションはプッシュ ボタン (オプションの種類TVOT_PUSHBUTTON) であり、ユーザーはそのボタンをクリックしました。

プッシュ ボタン 項目の OPTPARAMスタイル フィールドは、PUSHBUTTON_TYPE_CALLBACKに設定されます。

CPSUICB_REASON_SEL_CHANGED

ユーザーは、 pCurItem が指すオプションの選択された値を変更しました。

CPSUICB_REASON_SETACTIVE

プロパティ シート ページがアクティブになりようとしており、CPSUI は PSN_SETACTIVE 通知メッセージを受信しました。 CPSUI は pCurItem を pOptItem に含まれる値に設定し、 pOldSel をCOMPROPSHEETUI 構造体を指すように設定します。

hDlg

現在アクティブなダイアログ ボックスへの CPSUI 提供のハンドル。

pOptItem

OPTITEM 構造体の配列への CPSUI 提供のポインター。 これは、アプリケーションが COMPROPSHEETUI 構造体で以前に指定したポインターと同じです。

cOptItem

pOptItem が指す配列内の CPSUI で指定された OPTITEM 構造体の数。 これは、アプリケーションが COMPROPSHEETUI 構造体で以前に指定した番号と同じです。

Flags

CPSUI 提供のフラグ。 これは、アプリケーションが COMPROPSHEETUI 構造体で以前に指定したのと同じフラグのセットです。

pCurItem

pOptItem が指す OPTITEM 配列のメンバーへの CPSUI 提供のポインター。 この配列メンバーは、コールバック関数が呼び出されたオプションである "current" オプションを表します。

DUMMYUNIONNAME

DUMMYUNIONNAME 共用体を定義します。

DUMMYUNIONNAME.OldSel

Reason メンバーにCPSUICB_REASON_SEL_CHANGEDが含まれている場合、CPSUI はこの共用体を pCurItem が指す OPTITEM 構造体の OldSel/pOldSel メンバーの前の内容に設定します。

その他すべての Reason 値では、この共用体の内容は無視する必要があります。

DUMMYUNIONNAME.pOldSel

Reason メンバーにCPSUICB_REASON_SEL_CHANGEDが含まれている場合、CPSUI はこの共用体を pCurItem が指す OPTITEM 構造体の OldSel/pOldSel メンバーの前の内容に設定します。

その他すべての Reason 値では、この共用体の内容は無視する必要があります。

UserData

CPSUI 提供のユーザー データ。 これは、アプリケーションが COMPROPSHEETUI 構造体で以前に指定した値と同じです。

Result

_CPSUICALLBACK型指定コールバック関数によって提供される結果値。 既定では、CPSUI はこの値をCPSUI_OKに設定します。 コールバック関数が戻った後、CPSUI は ComPropSheet 関数を CPSFUNC_SET_RESULT の関数コードで呼び出し、 Reason メンバーの内容を結果値として指定します。

このメンバーは、 Reason メンバーがCPSUICB_REASON_APPLYNOWであり、コールバック関数がCPSUI_ACTION_NO_APPLY_EXITを返さない場合にのみ使用されます。

要件

要件 値
Header compstui.h (Compstui.h を含む)