RemovePropA 関数 (winuser.h)

[アーティクル]
03/09/2024

指定したウィンドウのプロパティリストからエントリを削除します。指定した文字列は、削除するエントリを識別します。

構文

HANDLE RemovePropA(
  [in] HWND   hWnd,
  [in] LPCSTR lpString
);

パラメーター

[in] hWnd

型: HWND

プロパティリストを変更するウィンドウへのハンドル。

[in] lpString

型: LPCTSTR

null で終わる文字列、または文字列を識別するアトム。このパラメーターが atom の場合は、 GlobalAddAtom 関数を使用して作成されている必要があります。 16 ビット値である atom は、 lpString の下位ワードに配置する必要があります。高次語は 0 である必要があります。

戻り値

型: HANDLE

戻り値は、指定されたデータを識別します。指定したプロパティリストにデータが見つからない場合、戻り値は NULL です。

注釈

戻り値は、SetProp に渡された hData 値です。これはアプリケーション定義の値です。この関数は、データとウィンドウの間の関連付けを破棄するだけです。必要に応じて、アプリケーションは、プロパティリストから削除されたエントリに関連付けられているデータハンドルを解放する必要があります。アプリケーションは、追加したプロパティのみを削除できます。他のアプリケーションまたはシステム自体によって追加されたプロパティを削除することはできません。

RemoveProp 関数は、アプリケーションがハンドルに関連付けられているデータを解放できるように、文字列に関連付けられているデータハンドルを返します。

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

例

例については、「ウィンドウプロパティの削除」を参照してください。

注意

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

要件

要件	値
サポートされている最小のクライアント	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-0 (Windows 8で導入)