_CPSUICALLBACK コールバック関数 (compstui.h)

  • [アーティクル]

_CPSUICALLBACK関数の種類は、CPSUI メッセージ ハンドラーとして使用することを目的としたコールバック関数を定義するために 、CPSUI アプリケーション (プリンター インターフェイス DLL を含む) によって使用されます。

構文

_CPSUICALLBACK Cpsuicallback;

LONG Cpsuicallback(
  PCPSUICBPARAM pCPSUICBParam
)
{...}

パラメーター

pCPSUICBParam

CPSUICBPARAM 構造体への CPSUI 提供のポインター。

戻り値

_CPSUICALLBACK型コールバック関数は、次の表に示す値のいずれかを返す必要があります。 各値は、CPSUI が実行する必要があるアクションを示します。

リターン コード 説明
CPSUICB_ACTION_ITEMS_APPLIED CPSUICBPARAM 構造体の Reason メンバーが CPSUICB_REASON_APPLYNOW に設定され、コールバック関数が現在のオプション値を正常に処理しました。
CPSUICB_ACTION_NO_APPLY_EXIT CPSUICBPARAM 構造体の Reason メンバーがCPSUICB_REASON_APPLYNOWに設定されましたが、コールバック関数によって無効なオプション値または互換性のないオプション値が検出されました。 コールバック関数は、ユーザーに問題を通知するダイアログ ボックスを表示する必要があります。
CPSUICB_ACTION_NONE CPSUI によるアクションは必要ありません。
CPSUICB_ACTION_OPTIF_CHANGED コールバック関数は、選択したオプションが変更されたこと、または別の OPTIF プレフィックス付きフラグが変更されたことを示すために、 OPTITEM 構造体に OPTIF_CHANGED フラグを設定しました。
CPSUICB_ACTION_REINIT_ITEMS コールバック関数は、関連付けられた OPTTYPE または OPTPARAM 構造体の Flags または pData メンバーが変更されたことを示すために、OPTITEM 構造体に OPTIF_CHANGED フラグを設定しました。

注釈

_CPSUICALLBACK関数型を使用して指定されたコールバック関数は、 CPSUI を使用してプロパティ シート ページを管理するアプリケーションによって提供されます。 これらのコールバック関数のいずれかがプロパティ シート ページに関連付けられている場合、CPSUI はユーザー アクティビティ (ページのコントロール フォーカスの変更、オプション値の変更、 OK のクリックなど) が検出されたときに呼び出します。

_CPSUICALLBACK型のコールバック関数は、COMPROPSHEETUI 構造体にアドレスを含めることでプロパティ シート ページに割り当てられます。このアドレスは、関数コードがCPSFUNC_ADD_PCOMPROPSHEETUIされたときに CPSUI の ComPropSheet 関数に渡されます。

さらに、 EXTPUSH 構造体を使用して、拡張プッシュ ボタンにコールバック関数を割り当てることができます。

これらのコールバック関数のいずれかが呼び出されると、 CPSUICBPARAM 構造体へのポインターを受け取ります。 この構造体は、ページの現在のオプション設定を記述し、関数が呼び出される原因となったユーザー イベントを示します。 コールバック関数は、設定の検証と処理を行います。 設定 (または設定の組み合わせ) が無効な場合は、ダイアログ ボックスが表示されます。 関数の戻り値は、ページを再表示するか再初期化する必要があるかを CPSUI に示します。

DLGPAGE 構造体の DlgProc メンバーがアプリケーション指定のダイアログ ボックス プロシージャを指定している場合、この関数の種類で指定されたコールバック関数は使用できません。 これは、_CPSUICALLBACK型指定のコールバックが CPSUI のダイアログ ボックス プロシージャから呼び出されるためです。これは、アプリケーションが独自のプロシージャを提供する場合には使用されません。

要件

要件 値
対象プラットフォーム デスクトップ
Header compstui.h (Compstui.h を含む)