SetCPSUIUserData 関数 (compstui.h)

  • [アーティクル]

CPSUI の SetCPSUIUserData 関数を使用すると、CPSUI アプリケーション (プリンター インターフェイス DLL を含む) で、表示されていないデータをプロパティ シート ダイアログ ボックスに関連付けることができます。

構文

BOOL SetCPSUIUserData(
  HWND      hDlg,
  ULONG_PTR CPSUIUserData
);

パラメーター

hDlg

プロパティ シート ダイアログ ボックスへの呼び出し元指定ハンドル。 詳細については、以下の「解説」セクションを参照してください。

CPSUIUserData

格納する呼び出し元から指定された値。

戻り値

この関数は、表示されていないデータをプロパティ シート ダイアログ ボックスに関連付けることに成功した場合は TRUE を返し、それ以外の場合は FALSE を 返します。

注釈

SetCPSUIUserData 関数は、DLGPAGE または EXTPUSH 構造体を使用してダイアログ ボックスに関連付けられているダイアログ ボックス プロシージャ内からのみ呼び出す必要があります。

SetCPSUIUserData を呼び出して格納される値は、後で GetCPSUIUserData を呼び出すことによって取得できます。

hDlg に指定するハンドルは、ダイアログ ボックス プロシージャへの入力として受け取るハンドルである必要があります。

要件

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