Win32 API 日本語リファレンス
ホームSystem.StationsAndDesktops › EnumDesktopsA

EnumDesktopsA

関数
ウィンドウステーション内のデスクトップを列挙する。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumDesktopsA(
    HWINSTA hwinsta,   // optional
    DESKTOPENUMPROCA lpEnumFunc,
    LPARAM lParam
);

パラメーター

名前方向説明
hwinstaHWINSTAinoptional列挙対象のウィンドウステーションハンドル。NULL で現在のステーション。
lpEnumFuncDESKTOPENUMPROCAin各デスクトップ名ごとに呼ばれるコールバック関数(ANSI)へのポインタ。
lParamLPARAMinコールバックへそのまま渡されるアプリ定義の値。

戻り値の型: BOOL

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumDesktopsA(
    HWINSTA hwinsta,   // optional
    DESKTOPENUMPROCA lpEnumFunc,
    LPARAM lParam
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDesktopsA(
    IntPtr hwinsta,   // HWINSTA optional
    IntPtr lpEnumFunc,   // DESKTOPENUMPROCA
    IntPtr lParam   // LPARAM
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDesktopsA(
    hwinsta As IntPtr,   ' HWINSTA optional
    lpEnumFunc As IntPtr,   ' DESKTOPENUMPROCA
    lParam As IntPtr   ' LPARAM
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hwinsta : HWINSTA optional
' lpEnumFunc : DESKTOPENUMPROCA
' lParam : LPARAM
Declare PtrSafe Function EnumDesktopsA Lib "user32" ( _
    ByVal hwinsta As LongPtr, _
    ByVal lpEnumFunc As LongPtr, _
    ByVal lParam As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnumDesktopsA = ctypes.windll.user32.EnumDesktopsA
EnumDesktopsA.restype = wintypes.BOOL
EnumDesktopsA.argtypes = [
    wintypes.HANDLE,  # hwinsta : HWINSTA optional
    ctypes.c_void_p,  # lpEnumFunc : DESKTOPENUMPROCA
    ctypes.c_ssize_t,  # lParam : LPARAM
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumDesktopsA = Fiddle::Function.new(
  lib['EnumDesktopsA'],
  [
    Fiddle::TYPE_VOIDP,  # hwinsta : HWINSTA optional
    Fiddle::TYPE_VOIDP,  # lpEnumFunc : DESKTOPENUMPROCA
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn EnumDesktopsA(
        hwinsta: *mut core::ffi::c_void,  // HWINSTA optional
        lpEnumFunc: *const core::ffi::c_void,  // DESKTOPENUMPROCA
        lParam: isize  // LPARAM
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool EnumDesktopsA(IntPtr hwinsta, IntPtr lpEnumFunc, IntPtr lParam);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumDesktopsA' -Namespace Win32 -PassThru
# $api::EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
#uselib "USER32.dll"
#func global EnumDesktopsA "EnumDesktopsA" sptr, sptr, sptr
; EnumDesktopsA hwinsta, lpEnumFunc, lParam   ; 戻り値は stat
; hwinsta : HWINSTA optional -> "sptr"
; lpEnumFunc : DESKTOPENUMPROCA -> "sptr"
; lParam : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global EnumDesktopsA "EnumDesktopsA" sptr, sptr, sptr
; res = EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
; hwinsta : HWINSTA optional -> "sptr"
; lpEnumFunc : DESKTOPENUMPROCA -> "sptr"
; lParam : LPARAM -> "sptr"
; BOOL EnumDesktopsA(HWINSTA hwinsta, DESKTOPENUMPROCA lpEnumFunc, LPARAM lParam)
#uselib "USER32.dll"
#cfunc global EnumDesktopsA "EnumDesktopsA" intptr, intptr, intptr
; res = EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
; hwinsta : HWINSTA optional -> "intptr"
; lpEnumFunc : DESKTOPENUMPROCA -> "intptr"
; lParam : LPARAM -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procEnumDesktopsA = user32.NewProc("EnumDesktopsA")
)

// hwinsta (HWINSTA optional), lpEnumFunc (DESKTOPENUMPROCA), lParam (LPARAM)
r1, _, err := procEnumDesktopsA.Call(
	uintptr(hwinsta),
	uintptr(lpEnumFunc),
	uintptr(lParam),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumDesktopsA(
  hwinsta: THandle;   // HWINSTA optional
  lpEnumFunc: Pointer;   // DESKTOPENUMPROCA
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'USER32.dll' name 'EnumDesktopsA';
result := DllCall("USER32\EnumDesktopsA"
    , "Ptr", hwinsta   ; HWINSTA optional
    , "Ptr", lpEnumFunc   ; DESKTOPENUMPROCA
    , "Ptr", lParam   ; LPARAM
    , "Int")   ; return: BOOL
●EnumDesktopsA(hwinsta, lpEnumFunc, lParam) = DLL("USER32.dll", "bool EnumDesktopsA(void*, void*, int)")
# 呼び出し: EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
# hwinsta : HWINSTA optional -> "void*"
# lpEnumFunc : DESKTOPENUMPROCA -> "void*"
# lParam : LPARAM -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn EnumDesktopsA(
    hwinsta: ?*anyopaque, // HWINSTA optional
    lpEnumFunc: ?*anyopaque, // DESKTOPENUMPROCA
    lParam: isize // LPARAM
) callconv(std.os.windows.WINAPI) i32;
proc EnumDesktopsA(
    hwinsta: pointer,  # HWINSTA optional
    lpEnumFunc: pointer,  # DESKTOPENUMPROCA
    lParam: int  # LPARAM
): int32 {.importc: "EnumDesktopsA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int EnumDesktopsA(
    void* hwinsta,   // HWINSTA optional
    void* lpEnumFunc,   // DESKTOPENUMPROCA
    ptrdiff_t lParam   // LPARAM
);
ccall((:EnumDesktopsA, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Int),
      hwinsta, lpEnumFunc, lParam)
# hwinsta : HWINSTA optional -> Ptr{Cvoid}
# lpEnumFunc : DESKTOPENUMPROCA -> Ptr{Cvoid}
# lParam : LPARAM -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumDesktopsA(
    void* hwinsta,
    void* lpEnumFunc,
    intptr_t lParam);
]]
local user32 = ffi.load("user32")
-- user32.EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
-- hwinsta : HWINSTA optional
-- lpEnumFunc : DESKTOPENUMPROCA
-- lParam : LPARAM
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const EnumDesktopsA = lib.func('__stdcall', 'EnumDesktopsA', 'int32_t', ['void *', 'void *', 'intptr_t']);
// EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
// hwinsta : HWINSTA optional -> 'void *'
// lpEnumFunc : DESKTOPENUMPROCA -> 'void *'
// lParam : LPARAM -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("USER32.dll", {
  EnumDesktopsA: { parameters: ["pointer", "pointer", "isize"], result: "i32" },
});
// lib.symbols.EnumDesktopsA(hwinsta, lpEnumFunc, lParam)
// hwinsta : HWINSTA optional -> "pointer"
// lpEnumFunc : DESKTOPENUMPROCA -> "pointer"
// lParam : LPARAM -> "isize"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumDesktopsA(
    void* hwinsta,
    void* lpEnumFunc,
    intptr_t lParam);
C, "USER32.dll");
// $ffi->EnumDesktopsA(hwinsta, lpEnumFunc, lParam);
// hwinsta : HWINSTA optional
// lpEnumFunc : DESKTOPENUMPROCA
// lParam : LPARAM
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class, W32APIOptions.ASCII_OPTIONS);
    boolean EnumDesktopsA(
        Pointer hwinsta,   // HWINSTA optional
        Callback lpEnumFunc,   // DESKTOPENUMPROCA
        long lParam   // LPARAM
    );
}
@[Link("user32")]
lib LibUSER32
  fun EnumDesktopsA = EnumDesktopsA(
    hwinsta : Void*,   # HWINSTA optional
    lpEnumFunc : Void*,   # DESKTOPENUMPROCA
    lParam : LibC::SSizeT   # LPARAM
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EnumDesktopsANative = Int32 Function(Pointer<Void>, Pointer<Void>, IntPtr);
typedef EnumDesktopsADart = int Function(Pointer<Void>, Pointer<Void>, int);
final EnumDesktopsA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<EnumDesktopsANative, EnumDesktopsADart>('EnumDesktopsA');
// hwinsta : HWINSTA optional -> Pointer<Void>
// lpEnumFunc : DESKTOPENUMPROCA -> Pointer<Void>
// lParam : LPARAM -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumDesktopsA(
  hwinsta: THandle;   // HWINSTA optional
  lpEnumFunc: Pointer;   // DESKTOPENUMPROCA
  lParam: NativeInt   // LPARAM
): BOOL; stdcall;
  external 'USER32.dll' name 'EnumDesktopsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumDesktopsA"
  c_EnumDesktopsA :: Ptr () -> Ptr () -> CIntPtr -> IO CInt
-- hwinsta : HWINSTA optional -> Ptr ()
-- lpEnumFunc : DESKTOPENUMPROCA -> Ptr ()
-- lParam : LPARAM -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enumdesktopsa =
  foreign "EnumDesktopsA"
    ((ptr void) @-> (ptr void) @-> intptr_t @-> returning int32_t)
(* hwinsta : HWINSTA optional -> (ptr void) *)
(* lpEnumFunc : DESKTOPENUMPROCA -> (ptr void) *)
(* lParam : LPARAM -> intptr_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("EnumDesktopsA" enum-desktops-a :convention :stdcall) :int32
  (hwinsta :pointer)   ; HWINSTA optional
  (lp-enum-func :pointer)   ; DESKTOPENUMPROCA
  (l-param :int64))   ; LPARAM
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumDesktopsA = Win32::API::More->new('USER32',
    'BOOL EnumDesktopsA(HANDLE hwinsta, LPVOID lpEnumFunc, LPARAM lParam)');
# my $ret = $EnumDesktopsA->Call($hwinsta, $lpEnumFunc, $lParam);
# hwinsta : HWINSTA optional -> HANDLE
# lpEnumFunc : DESKTOPENUMPROCA -> LPVOID
# lParam : LPARAM -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

文字セット違い
使用する型