EnumDesktopsA 関数 (winuser.h)

呼び出し元プロセスの指定されたウィンドウ ステーションに関連付けられているすべてのデスクトップを列挙します。 関数は、各デスクトップの名前をアプリケーション定義のコールバック関数に渡します。

構文

BOOL EnumDesktopsA(
  [in, optional] HWINSTA          hwinsta,
  [in]           DESKTOPENUMPROCA lpEnumFunc,
  [in]           LPARAM           lParam
);

パラメーター

[in, optional] hwinsta

デスクトップを列挙するウィンドウ ステーションへのハンドル。 このハンドルは 、CreateWindowStation、 GetProcessWindowStation、または OpenWindowStation 関数によって返され、WINSTA_ENUMDESKTOPSアクセス権が必要です。 詳細については、「 Window Station のセキュリティとアクセス権」を参照してください。

このパラメーターが NULL の場合は、現在のウィンドウステーションが使用されます。

[in] lpEnumFunc

アプリケーション定義の EnumDesktopProc コールバック関数へのポインター。

[in] lParam

コールバック関数に渡されるアプリケーション定義値。

戻り値

関数が成功した場合、 lpEnumFunc によって指されたコールバック関数によって返される 0 以外の値が返されます。

関数が列挙を実行できない場合、戻り値は 0 です。 拡張されたエラー情報を取得するには、GetLastError を呼び出します。

コールバック関数が失敗した場合、戻り値は 0 です。 コールバック関数は SetLastError を呼び出して 、GetLastError を呼び出して取得する呼び出し元のエラー コードを設定できます。

解説

EnumDesktops 関数は、呼び出し元プロセスがDESKTOP_ENUMERATEアクセス権を持つデスクトップのみを列挙します。 詳細については、「 デスクトップ セキュリティとアクセス権」を参照してください。

EnumDesktops 関数は、最後のデスクトップが列挙されるか、コールバック関数が FALSE を返すまで lpEnumFunc コールバック関数を繰り返し呼び出します。

注意

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

要件

サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll

関連項目

CreateWindowStation

デスクトップ

EnumDesktopProc

GetProcessWindowStation

OpenWindowStation

ウィンドウ ステーションとデスクトップ関数