SetPropA 関数 (winuser.h)

  • [アーティクル]

新しいエントリを追加するか、指定したウィンドウのプロパティ リスト内の既存のエントリを変更します。 指定した文字列がリストにまだ存在しない場合、関数はリストに新しいエントリを追加します。 新しいエントリには、文字列とハンドルが含まれています。 それ以外の場合、関数は文字列の現在のハンドルを指定されたハンドルに置き換えます。

構文

BOOL SetPropA(
  [in]           HWND   hWnd,
  [in]           LPCSTR lpString,
  [in, optional] HANDLE hData
);

パラメーター

[in] hWnd

型: HWND

プロパティ リストが新しいエントリを受け取るウィンドウのハンドル。

[in] lpString

種類: LPCTSTR

null で終わる文字列、または文字列を識別するアトム。 このパラメーターが atom の場合は、 GlobalAddAtom 関数の以前の呼び出しによって作成されたグローバル アトムである必要があります。 atom は lpString の下位ワードに配置する必要があります。上位ワードは 0 である必要があります。

[in, optional] hData

型: HANDLE

プロパティ リストにコピーするデータのハンドル。 データ ハンドルは、アプリケーションに役立つ任意の値を識別できます。

戻り値

種類: BOOL

データ ハンドルと文字列がプロパティ リストに追加された場合、戻り値は 0 以外です。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

ウィンドウが破棄される前 (つまり、 WM_NCDESTROY メッセージの処理から戻る前)、アプリケーションはプロパティ リストに追加したすべてのエントリを削除する必要があります。 アプリケーションでは、 RemoveProp 関数を使用してエントリを削除する必要があります。

SetProp は、ユーザー インターフェイス特権分離 (UIPI) の制限に従います。 プロセスは、整合性レベルが小さいか等しいプロセスに属するウィンドウでのみ、この関数を呼び出すことができます。 UIPI がプロパティの変更をブロックすると、 GetLastError は 5 を返します。

例

例については、「 Window プロパティの追加」を参照してください。

注意

winuser.h ヘッダーは、SetProp をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-window-l1-1-4 (Windows 10 バージョン 10.0.14393 で導入)

関連項目

概念

GlobalAddAtom

リファレンス

RemoveProp

WM_NCDESTROY

ウィンドウ プロパティ

ITaskbarList2::MarkFullscreenWindow