Win32 API 日本語リファレンス
ホームNetworking.Clustering › ClusterNetInterfaceEnum

ClusterNetInterfaceEnum

関数
ネットワークインターフェイス列挙から名前を取得する。
DLLCLUSAPI.dll呼出規約winapi対応OSwindowsserver2016

シグネチャ

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

DWORD ClusterNetInterfaceEnum(
    HNETINTERFACEENUM hNetInterfaceEnum,
    DWORD dwIndex,
    LPWSTR lpszName,
    DWORD* lpcchName
);

パラメーター

名前方向説明
hNetInterfaceEnumHNETINTERFACEENUMinClusterNetInterfaceOpenEnumで取得した列挙ハンドル。
dwIndexDWORDin取得する要素の0始まりインデックス。
lpszNameLPWSTRout取得したネットワークインターフェース名を受け取るバッファへのポインタ。
lpcchNameDWORD*inout入出力で名前バッファの容量と文字数を受け渡すポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD ClusterNetInterfaceEnum(
    HNETINTERFACEENUM hNetInterfaceEnum,
    DWORD dwIndex,
    LPWSTR lpszName,
    DWORD* lpcchName
);
[DllImport("CLUSAPI.dll", ExactSpelling = true)]
static extern uint ClusterNetInterfaceEnum(
    IntPtr hNetInterfaceEnum,   // HNETINTERFACEENUM
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszName,   // LPWSTR out
    ref uint lpcchName   // DWORD* in/out
);
<DllImport("CLUSAPI.dll", ExactSpelling:=True)>
Public Shared Function ClusterNetInterfaceEnum(
    hNetInterfaceEnum As IntPtr,   ' HNETINTERFACEENUM
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpszName As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpcchName As UInteger   ' DWORD* in/out
) As UInteger
End Function
' hNetInterfaceEnum : HNETINTERFACEENUM
' dwIndex : DWORD
' lpszName : LPWSTR out
' lpcchName : DWORD* in/out
Declare PtrSafe Function ClusterNetInterfaceEnum Lib "clusapi" ( _
    ByVal hNetInterfaceEnum As LongPtr, _
    ByVal dwIndex As Long, _
    ByVal lpszName As LongPtr, _
    ByRef lpcchName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ClusterNetInterfaceEnum = ctypes.windll.clusapi.ClusterNetInterfaceEnum
ClusterNetInterfaceEnum.restype = wintypes.DWORD
ClusterNetInterfaceEnum.argtypes = [
    ctypes.c_ssize_t,  # hNetInterfaceEnum : HNETINTERFACEENUM
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPWSTR,  # lpszName : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpcchName : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	clusapi = windows.NewLazySystemDLL("CLUSAPI.dll")
	procClusterNetInterfaceEnum = clusapi.NewProc("ClusterNetInterfaceEnum")
)

// hNetInterfaceEnum (HNETINTERFACEENUM), dwIndex (DWORD), lpszName (LPWSTR out), lpcchName (DWORD* in/out)
r1, _, err := procClusterNetInterfaceEnum.Call(
	uintptr(hNetInterfaceEnum),
	uintptr(dwIndex),
	uintptr(lpszName),
	uintptr(lpcchName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function ClusterNetInterfaceEnum(
  hNetInterfaceEnum: NativeInt;   // HNETINTERFACEENUM
  dwIndex: DWORD;   // DWORD
  lpszName: PWideChar;   // LPWSTR out
  lpcchName: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'ClusterNetInterfaceEnum';
result := DllCall("CLUSAPI\ClusterNetInterfaceEnum"
    , "Ptr", hNetInterfaceEnum   ; HNETINTERFACEENUM
    , "UInt", dwIndex   ; DWORD
    , "Ptr", lpszName   ; LPWSTR out
    , "Ptr", lpcchName   ; DWORD* in/out
    , "UInt")   ; return: DWORD
●ClusterNetInterfaceEnum(hNetInterfaceEnum, dwIndex, lpszName, lpcchName) = DLL("CLUSAPI.dll", "dword ClusterNetInterfaceEnum(int, dword, char*, void*)")
# 呼び出し: ClusterNetInterfaceEnum(hNetInterfaceEnum, dwIndex, lpszName, lpcchName)
# hNetInterfaceEnum : HNETINTERFACEENUM -> "int"
# dwIndex : DWORD -> "dword"
# lpszName : LPWSTR out -> "char*"
# lpcchName : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ClusterNetInterfaceEnumNative = Uint32 Function(IntPtr, Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef ClusterNetInterfaceEnumDart = int Function(int, int, Pointer<Utf16>, Pointer<Uint32>);
final ClusterNetInterfaceEnum = DynamicLibrary.open('CLUSAPI.dll')
    .lookupFunction<ClusterNetInterfaceEnumNative, ClusterNetInterfaceEnumDart>('ClusterNetInterfaceEnum');
// hNetInterfaceEnum : HNETINTERFACEENUM -> IntPtr
// dwIndex : DWORD -> Uint32
// lpszName : LPWSTR out -> Pointer<Utf16>
// lpcchName : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ClusterNetInterfaceEnum(
  hNetInterfaceEnum: NativeInt;   // HNETINTERFACEENUM
  dwIndex: DWORD;   // DWORD
  lpszName: PWideChar;   // LPWSTR out
  lpcchName: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'CLUSAPI.dll' name 'ClusterNetInterfaceEnum';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ClusterNetInterfaceEnum"
  c_ClusterNetInterfaceEnum :: CIntPtr -> Word32 -> CWString -> Ptr Word32 -> IO Word32
-- hNetInterfaceEnum : HNETINTERFACEENUM -> CIntPtr
-- dwIndex : DWORD -> Word32
-- lpszName : LPWSTR out -> CWString
-- lpcchName : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let clusternetinterfaceenum =
  foreign "ClusterNetInterfaceEnum"
    (intptr_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hNetInterfaceEnum : HNETINTERFACEENUM -> intptr_t *)
(* dwIndex : DWORD -> uint32_t *)
(* lpszName : LPWSTR out -> (ptr uint16_t) *)
(* lpcchName : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library clusapi (t "CLUSAPI.dll"))
(cffi:use-foreign-library clusapi)

(cffi:defcfun ("ClusterNetInterfaceEnum" cluster-net-interface-enum :convention :stdcall) :uint32
  (h-net-interface-enum :int64)   ; HNETINTERFACEENUM
  (dw-index :uint32)   ; DWORD
  (lpsz-name :pointer)   ; LPWSTR out
  (lpcch-name :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ClusterNetInterfaceEnum = Win32::API::More->new('CLUSAPI',
    'DWORD ClusterNetInterfaceEnum(LPARAM hNetInterfaceEnum, DWORD dwIndex, LPWSTR lpszName, LPVOID lpcchName)');
# my $ret = $ClusterNetInterfaceEnum->Call($hNetInterfaceEnum, $dwIndex, $lpszName, $lpcchName);
# hNetInterfaceEnum : HNETINTERFACEENUM -> LPARAM
# dwIndex : DWORD -> DWORD
# lpszName : LPWSTR out -> LPWSTR
# lpcchName : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。