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

EcEnumNextSubscription

関数
次のサブスクリプション名を列挙して取得する。
DLLWecApi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// WecApi.dll
#include <windows.h>

BOOL EcEnumNextSubscription(
    INT_PTR SubscriptionEnum,
    DWORD SubscriptionNameBufferSize,
    LPWSTR SubscriptionNameBuffer,   // optional
    DWORD* SubscriptionNameBufferUsed
);

パラメーター

名前方向説明
SubscriptionEnumINT_PTRinEcOpenSubscriptionEnumで取得した列挙ハンドル(INT_PTR)。
SubscriptionNameBufferSizeDWORDinSubscriptionNameBufferの文字数。
SubscriptionNameBufferLPWSTRoutoptional次のサブスクリプション名を受け取る出力バッファ。NULLでサイズ問い合わせ可。
SubscriptionNameBufferUsedDWORD*out必要/使用文字数を受け取るDWORDへのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

// WecApi.dll
#include <windows.h>

BOOL EcEnumNextSubscription(
    INT_PTR SubscriptionEnum,
    DWORD SubscriptionNameBufferSize,
    LPWSTR SubscriptionNameBuffer,   // optional
    DWORD* SubscriptionNameBufferUsed
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WecApi.dll", ExactSpelling = true)]
static extern bool EcEnumNextSubscription(
    IntPtr SubscriptionEnum,   // INT_PTR
    uint SubscriptionNameBufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder SubscriptionNameBuffer,   // LPWSTR optional, out
    out uint SubscriptionNameBufferUsed   // DWORD* out
);
<DllImport("WecApi.dll", ExactSpelling:=True)>
Public Shared Function EcEnumNextSubscription(
    SubscriptionEnum As IntPtr,   ' INT_PTR
    SubscriptionNameBufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> SubscriptionNameBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    <Out> ByRef SubscriptionNameBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' SubscriptionEnum : INT_PTR
' SubscriptionNameBufferSize : DWORD
' SubscriptionNameBuffer : LPWSTR optional, out
' SubscriptionNameBufferUsed : DWORD* out
Declare PtrSafe Function EcEnumNextSubscription Lib "wecapi" ( _
    ByVal SubscriptionEnum As LongPtr, _
    ByVal SubscriptionNameBufferSize As Long, _
    ByVal SubscriptionNameBuffer As LongPtr, _
    ByRef SubscriptionNameBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EcEnumNextSubscription = ctypes.windll.wecapi.EcEnumNextSubscription
EcEnumNextSubscription.restype = wintypes.BOOL
EcEnumNextSubscription.argtypes = [
    ctypes.c_ssize_t,  # SubscriptionEnum : INT_PTR
    wintypes.DWORD,  # SubscriptionNameBufferSize : DWORD
    wintypes.LPWSTR,  # SubscriptionNameBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # SubscriptionNameBufferUsed : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WecApi.dll')
EcEnumNextSubscription = Fiddle::Function.new(
  lib['EcEnumNextSubscription'],
  [
    Fiddle::TYPE_INTPTR_T,  # SubscriptionEnum : INT_PTR
    -Fiddle::TYPE_INT,  # SubscriptionNameBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # SubscriptionNameBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # SubscriptionNameBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wecapi")]
extern "system" {
    fn EcEnumNextSubscription(
        SubscriptionEnum: isize,  // INT_PTR
        SubscriptionNameBufferSize: u32,  // DWORD
        SubscriptionNameBuffer: *mut u16,  // LPWSTR optional, out
        SubscriptionNameBufferUsed: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WecApi.dll")]
public static extern bool EcEnumNextSubscription(IntPtr SubscriptionEnum, uint SubscriptionNameBufferSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder SubscriptionNameBuffer, out uint SubscriptionNameBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WecApi_EcEnumNextSubscription' -Namespace Win32 -PassThru
# $api::EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
#uselib "WecApi.dll"
#func global EcEnumNextSubscription "EcEnumNextSubscription" sptr, sptr, sptr, sptr
; EcEnumNextSubscription SubscriptionEnum, SubscriptionNameBufferSize, varptr(SubscriptionNameBuffer), varptr(SubscriptionNameBufferUsed)   ; 戻り値は stat
; SubscriptionEnum : INT_PTR -> "sptr"
; SubscriptionNameBufferSize : DWORD -> "sptr"
; SubscriptionNameBuffer : LPWSTR optional, out -> "sptr"
; SubscriptionNameBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WecApi.dll"
#cfunc global EcEnumNextSubscription "EcEnumNextSubscription" sptr, int, var, var
; res = EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
; SubscriptionEnum : INT_PTR -> "sptr"
; SubscriptionNameBufferSize : DWORD -> "int"
; SubscriptionNameBuffer : LPWSTR optional, out -> "var"
; SubscriptionNameBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL EcEnumNextSubscription(INT_PTR SubscriptionEnum, DWORD SubscriptionNameBufferSize, LPWSTR SubscriptionNameBuffer, DWORD* SubscriptionNameBufferUsed)
#uselib "WecApi.dll"
#cfunc global EcEnumNextSubscription "EcEnumNextSubscription" intptr, int, var, var
; res = EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
; SubscriptionEnum : INT_PTR -> "intptr"
; SubscriptionNameBufferSize : DWORD -> "int"
; SubscriptionNameBuffer : LPWSTR optional, out -> "var"
; SubscriptionNameBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wecapi = windows.NewLazySystemDLL("WecApi.dll")
	procEcEnumNextSubscription = wecapi.NewProc("EcEnumNextSubscription")
)

// SubscriptionEnum (INT_PTR), SubscriptionNameBufferSize (DWORD), SubscriptionNameBuffer (LPWSTR optional, out), SubscriptionNameBufferUsed (DWORD* out)
r1, _, err := procEcEnumNextSubscription.Call(
	uintptr(SubscriptionEnum),
	uintptr(SubscriptionNameBufferSize),
	uintptr(SubscriptionNameBuffer),
	uintptr(SubscriptionNameBufferUsed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EcEnumNextSubscription(
  SubscriptionEnum: NativeInt;   // INT_PTR
  SubscriptionNameBufferSize: DWORD;   // DWORD
  SubscriptionNameBuffer: PWideChar;   // LPWSTR optional, out
  SubscriptionNameBufferUsed: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WecApi.dll' name 'EcEnumNextSubscription';
result := DllCall("WecApi\EcEnumNextSubscription"
    , "Ptr", SubscriptionEnum   ; INT_PTR
    , "UInt", SubscriptionNameBufferSize   ; DWORD
    , "Ptr", SubscriptionNameBuffer   ; LPWSTR optional, out
    , "Ptr", SubscriptionNameBufferUsed   ; DWORD* out
    , "Int")   ; return: BOOL
●EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed) = DLL("WecApi.dll", "bool EcEnumNextSubscription(int, dword, char*, void*)")
# 呼び出し: EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
# SubscriptionEnum : INT_PTR -> "int"
# SubscriptionNameBufferSize : DWORD -> "dword"
# SubscriptionNameBuffer : LPWSTR optional, out -> "char*"
# SubscriptionNameBufferUsed : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wecapi" fn EcEnumNextSubscription(
    SubscriptionEnum: isize, // INT_PTR
    SubscriptionNameBufferSize: u32, // DWORD
    SubscriptionNameBuffer: [*c]u16, // LPWSTR optional, out
    SubscriptionNameBufferUsed: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc EcEnumNextSubscription(
    SubscriptionEnum: int,  # INT_PTR
    SubscriptionNameBufferSize: uint32,  # DWORD
    SubscriptionNameBuffer: ptr uint16,  # LPWSTR optional, out
    SubscriptionNameBufferUsed: ptr uint32  # DWORD* out
): int32 {.importc: "EcEnumNextSubscription", stdcall, dynlib: "WecApi.dll".}
pragma(lib, "wecapi");
extern(Windows)
int EcEnumNextSubscription(
    ptrdiff_t SubscriptionEnum,   // INT_PTR
    uint SubscriptionNameBufferSize,   // DWORD
    wchar* SubscriptionNameBuffer,   // LPWSTR optional, out
    uint* SubscriptionNameBufferUsed   // DWORD* out
);
ccall((:EcEnumNextSubscription, "WecApi.dll"), stdcall, Int32,
      (Int, UInt32, Ptr{UInt16}, Ptr{UInt32}),
      SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
# SubscriptionEnum : INT_PTR -> Int
# SubscriptionNameBufferSize : DWORD -> UInt32
# SubscriptionNameBuffer : LPWSTR optional, out -> Ptr{UInt16}
# SubscriptionNameBufferUsed : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EcEnumNextSubscription(
    intptr_t SubscriptionEnum,
    uint32_t SubscriptionNameBufferSize,
    uint16_t* SubscriptionNameBuffer,
    uint32_t* SubscriptionNameBufferUsed);
]]
local wecapi = ffi.load("wecapi")
-- wecapi.EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
-- SubscriptionEnum : INT_PTR
-- SubscriptionNameBufferSize : DWORD
-- SubscriptionNameBuffer : LPWSTR optional, out
-- SubscriptionNameBufferUsed : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WecApi.dll');
const EcEnumNextSubscription = lib.func('__stdcall', 'EcEnumNextSubscription', 'int32_t', ['intptr_t', 'uint32_t', 'uint16_t *', 'uint32_t *']);
// EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
// SubscriptionEnum : INT_PTR -> 'intptr_t'
// SubscriptionNameBufferSize : DWORD -> 'uint32_t'
// SubscriptionNameBuffer : LPWSTR optional, out -> 'uint16_t *'
// SubscriptionNameBufferUsed : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WecApi.dll", {
  EcEnumNextSubscription: { parameters: ["isize", "u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed)
// SubscriptionEnum : INT_PTR -> "isize"
// SubscriptionNameBufferSize : DWORD -> "u32"
// SubscriptionNameBuffer : LPWSTR optional, out -> "buffer"
// SubscriptionNameBufferUsed : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EcEnumNextSubscription(
    intptr_t SubscriptionEnum,
    uint32_t SubscriptionNameBufferSize,
    uint16_t* SubscriptionNameBuffer,
    uint32_t* SubscriptionNameBufferUsed);
C, "WecApi.dll");
// $ffi->EcEnumNextSubscription(SubscriptionEnum, SubscriptionNameBufferSize, SubscriptionNameBuffer, SubscriptionNameBufferUsed);
// SubscriptionEnum : INT_PTR
// SubscriptionNameBufferSize : DWORD
// SubscriptionNameBuffer : LPWSTR optional, out
// SubscriptionNameBufferUsed : DWORD* out
// 構造体/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 Wecapi extends StdCallLibrary {
    Wecapi INSTANCE = Native.load("wecapi", Wecapi.class);
    boolean EcEnumNextSubscription(
        long SubscriptionEnum,   // INT_PTR
        int SubscriptionNameBufferSize,   // DWORD
        char[] SubscriptionNameBuffer,   // LPWSTR optional, out
        IntByReference SubscriptionNameBufferUsed   // DWORD* out
    );
}
@[Link("wecapi")]
lib LibWecApi
  fun EcEnumNextSubscription = EcEnumNextSubscription(
    SubscriptionEnum : LibC::SSizeT,   # INT_PTR
    SubscriptionNameBufferSize : UInt32,   # DWORD
    SubscriptionNameBuffer : UInt16*,   # LPWSTR optional, out
    SubscriptionNameBufferUsed : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EcEnumNextSubscriptionNative = Int32 Function(IntPtr, Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef EcEnumNextSubscriptionDart = int Function(int, int, Pointer<Utf16>, Pointer<Uint32>);
final EcEnumNextSubscription = DynamicLibrary.open('WecApi.dll')
    .lookupFunction<EcEnumNextSubscriptionNative, EcEnumNextSubscriptionDart>('EcEnumNextSubscription');
// SubscriptionEnum : INT_PTR -> IntPtr
// SubscriptionNameBufferSize : DWORD -> Uint32
// SubscriptionNameBuffer : LPWSTR optional, out -> Pointer<Utf16>
// SubscriptionNameBufferUsed : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EcEnumNextSubscription(
  SubscriptionEnum: NativeInt;   // INT_PTR
  SubscriptionNameBufferSize: DWORD;   // DWORD
  SubscriptionNameBuffer: PWideChar;   // LPWSTR optional, out
  SubscriptionNameBufferUsed: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WecApi.dll' name 'EcEnumNextSubscription';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EcEnumNextSubscription"
  c_EcEnumNextSubscription :: CIntPtr -> Word32 -> CWString -> Ptr Word32 -> IO CInt
-- SubscriptionEnum : INT_PTR -> CIntPtr
-- SubscriptionNameBufferSize : DWORD -> Word32
-- SubscriptionNameBuffer : LPWSTR optional, out -> CWString
-- SubscriptionNameBufferUsed : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ecenumnextsubscription =
  foreign "EcEnumNextSubscription"
    (intptr_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* SubscriptionEnum : INT_PTR -> intptr_t *)
(* SubscriptionNameBufferSize : DWORD -> uint32_t *)
(* SubscriptionNameBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* SubscriptionNameBufferUsed : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wecapi (t "WecApi.dll"))
(cffi:use-foreign-library wecapi)

(cffi:defcfun ("EcEnumNextSubscription" ec-enum-next-subscription :convention :stdcall) :int32
  (subscription-enum :int64)   ; INT_PTR
  (subscription-name-buffer-size :uint32)   ; DWORD
  (subscription-name-buffer :pointer)   ; LPWSTR optional, out
  (subscription-name-buffer-used :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EcEnumNextSubscription = Win32::API::More->new('WecApi',
    'BOOL EcEnumNextSubscription(LPARAM SubscriptionEnum, DWORD SubscriptionNameBufferSize, LPWSTR SubscriptionNameBuffer, LPVOID SubscriptionNameBufferUsed)');
# my $ret = $EcEnumNextSubscription->Call($SubscriptionEnum, $SubscriptionNameBufferSize, $SubscriptionNameBuffer, $SubscriptionNameBufferUsed);
# SubscriptionEnum : INT_PTR -> LPARAM
# SubscriptionNameBufferSize : DWORD -> DWORD
# SubscriptionNameBuffer : LPWSTR optional, out -> LPWSTR
# SubscriptionNameBufferUsed : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。