GetUserObjectInformationA 関数 (winuser.h)

[アーティクル]
08/27/2023

指定したウィンドウステーションまたはデスクトップオブジェクトに関する情報を取得します。

構文

BOOL GetUserObjectInformationA(
  [in]            HANDLE  hObj,
  [in]            int     nIndex,
  [out, optional] PVOID   pvInfo,
  [in]            DWORD   nLength,
  [out, optional] LPDWORD lpnLengthNeeded
);

パラメーター

[in] hObj

ウィンドウステーションまたはデスクトップオブジェクトへのハンドル。このハンドルは、 CreateWindowStation、 OpenWindowStation、 CreateDesktop、または OpenDesktop 関数によって返されます。

[in] nIndex

取得する情報。パラメーターには、次のいずれかの値を指定できます。

値	意味
UOI_FLAGS 1	ハンドルフラグ。 pvInfo パラメーターは、USEROBJECTFLAGS 構造体を指している必要があります。
UOI_HEAPSIZE 5	ULONG 値としてのデスクトップヒープのサイズ (KB 単位)。 hObj パラメーターはデスクトップオブジェクトへのハンドルである必要があります。それ以外の場合、関数は失敗します。 Windows Server 2003 および Windows XP/2000: この値はサポートされていません。
UOI_IO 6	hObj パラメーターが、ユーザーからの入力を受け取っているデスクトップオブジェクトへのハンドルである場合は TRUE。それ以外の場合は FALSE。 Windows Server 2003 および Windows XP/2000: この値はサポートされていません。
UOI_NAME 2	オブジェクトの名前を文字列として指定します。
UOI_TYPE 3	オブジェクトの型名を文字列として指定します。
UOI_USER_SID 4	指定したオブジェクトに現在関連付けられているユーザーを識別する SID 構造体。オブジェクトにユーザーが関連付けられていない場合、 lpnLengthNeeded によって指されるバッファーで返される値は 0 です。 SID は可変長構造体であることに注意してください。通常、値を取得する前に、GETUserObjectInformation を呼び出して SID の長さを決定します。

[out, optional] pvInfo

オブジェクト情報を受け取るバッファーへのポインター。

[in] nLength

pvInfo パラメーターが指すバッファーのサイズ (バイト単位)。

[out, optional] lpnLengthNeeded

要求された情報を格納するために必要なバイト数を受け取る変数へのポインター。関数が戻るときに、この変数の値が nLength パラメーターの値より大きい場合、関数は FALSE を返し、情報のいずれも pvInfo バッファーにコピーされません。 lpnLengthNeeded が指す変数の値が nLength の値以下の場合は、情報ブロック全体がコピーされます。

戻り値

関数が成功すると、戻り値は 0 以外になります。

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

解説

注意

winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetUserObjectInformation を定義します。 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-windowstation-ansi-l1-1-0 (Windows 10 バージョン 10.0.10240 で導入)