Win32 API 日本語リファレンス
ホームStorage.DistributedFileSystem › NetDfsEnum

NetDfsEnum

関数
DFS名前空間のエントリ一覧を列挙する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD NetDfsEnum(
    LPWSTR DfsName,
    DWORD Level,
    DWORD PrefMaxLen,
    BYTE** Buffer,
    DWORD* EntriesRead,
    DWORD* ResumeHandle
);

パラメーター

名前方向説明
DfsNameLPWSTRin列挙対象のDFS名前空間のパスを示すワイド文字列。
LevelDWORDin取得する情報構造体のレベル(1,2,3等)。データ詳細度を指定する。
PrefMaxLenDWORDin返却バッファの推奨最大バイト数。MAX_PREFERRED_LENGTH指定で自動確保する。
BufferBYTE**out確保された情報配列を受け取るポインタへのポインタ。使用後NetApiBufferFreeで解放する。
EntriesReadDWORD*out実際に読み取られたエントリ数を受け取るDWORDへのポインタ。出力用。
ResumeHandleDWORD*inout列挙の継続位置を保持するDWORDへのポインタ。複数回呼び出しで使う。NULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD NetDfsEnum(
    LPWSTR DfsName,
    DWORD Level,
    DWORD PrefMaxLen,
    BYTE** Buffer,
    DWORD* EntriesRead,
    DWORD* ResumeHandle
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetDfsEnum(
    [MarshalAs(UnmanagedType.LPWStr)] string DfsName,   // LPWSTR
    uint Level,   // DWORD
    uint PrefMaxLen,   // DWORD
    IntPtr Buffer,   // BYTE** out
    out uint EntriesRead,   // DWORD* out
    ref uint ResumeHandle   // DWORD* in/out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetDfsEnum(
    <MarshalAs(UnmanagedType.LPWStr)> DfsName As String,   ' LPWSTR
    Level As UInteger,   ' DWORD
    PrefMaxLen As UInteger,   ' DWORD
    Buffer As IntPtr,   ' BYTE** out
    <Out> ByRef EntriesRead As UInteger,   ' DWORD* out
    ByRef ResumeHandle As UInteger   ' DWORD* in/out
) As UInteger
End Function
' DfsName : LPWSTR
' Level : DWORD
' PrefMaxLen : DWORD
' Buffer : BYTE** out
' EntriesRead : DWORD* out
' ResumeHandle : DWORD* in/out
Declare PtrSafe Function NetDfsEnum Lib "netapi32" ( _
    ByVal DfsName As LongPtr, _
    ByVal Level As Long, _
    ByVal PrefMaxLen As Long, _
    ByVal Buffer As LongPtr, _
    ByRef EntriesRead As Long, _
    ByRef ResumeHandle As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetDfsEnum = ctypes.windll.netapi32.NetDfsEnum
NetDfsEnum.restype = wintypes.DWORD
NetDfsEnum.argtypes = [
    wintypes.LPCWSTR,  # DfsName : LPWSTR
    wintypes.DWORD,  # Level : DWORD
    wintypes.DWORD,  # PrefMaxLen : DWORD
    ctypes.c_void_p,  # Buffer : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # EntriesRead : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetDfsEnum = netapi32.NewProc("NetDfsEnum")
)

// DfsName (LPWSTR), Level (DWORD), PrefMaxLen (DWORD), Buffer (BYTE** out), EntriesRead (DWORD* out), ResumeHandle (DWORD* in/out)
r1, _, err := procNetDfsEnum.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DfsName))),
	uintptr(Level),
	uintptr(PrefMaxLen),
	uintptr(Buffer),
	uintptr(EntriesRead),
	uintptr(ResumeHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetDfsEnum(
  DfsName: PWideChar;   // LPWSTR
  Level: DWORD;   // DWORD
  PrefMaxLen: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE** out
  EntriesRead: Pointer;   // DWORD* out
  ResumeHandle: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetDfsEnum';
result := DllCall("NETAPI32\NetDfsEnum"
    , "WStr", DfsName   ; LPWSTR
    , "UInt", Level   ; DWORD
    , "UInt", PrefMaxLen   ; DWORD
    , "Ptr", Buffer   ; BYTE** out
    , "Ptr", EntriesRead   ; DWORD* out
    , "Ptr", ResumeHandle   ; DWORD* in/out
    , "UInt")   ; return: DWORD
●NetDfsEnum(DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle) = DLL("NETAPI32.dll", "dword NetDfsEnum(char*, dword, dword, void*, void*, void*)")
# 呼び出し: NetDfsEnum(DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle)
# DfsName : LPWSTR -> "char*"
# Level : DWORD -> "dword"
# PrefMaxLen : DWORD -> "dword"
# Buffer : BYTE** out -> "void*"
# EntriesRead : DWORD* out -> "void*"
# ResumeHandle : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn NetDfsEnum(
    DfsName: [*c]const u16, // LPWSTR
    Level: u32, // DWORD
    PrefMaxLen: u32, // DWORD
    Buffer: [*c][*c]u8, // BYTE** out
    EntriesRead: [*c]u32, // DWORD* out
    ResumeHandle: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
proc NetDfsEnum(
    DfsName: WideCString,  # LPWSTR
    Level: uint32,  # DWORD
    PrefMaxLen: uint32,  # DWORD
    Buffer: ptr uint8,  # BYTE** out
    EntriesRead: ptr uint32,  # DWORD* out
    ResumeHandle: ptr uint32  # DWORD* in/out
): uint32 {.importc: "NetDfsEnum", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetDfsEnum(
    const(wchar)* DfsName,   // LPWSTR
    uint Level,   // DWORD
    uint PrefMaxLen,   // DWORD
    ubyte** Buffer,   // BYTE** out
    uint* EntriesRead,   // DWORD* out
    uint* ResumeHandle   // DWORD* in/out
);
ccall((:NetDfsEnum, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, UInt32, UInt32, Ptr{UInt8}, Ptr{UInt32}, Ptr{UInt32}),
      DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle)
# DfsName : LPWSTR -> Cwstring
# Level : DWORD -> UInt32
# PrefMaxLen : DWORD -> UInt32
# Buffer : BYTE** out -> Ptr{UInt8}
# EntriesRead : DWORD* out -> Ptr{UInt32}
# ResumeHandle : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetDfsEnum(
    const uint16_t* DfsName,
    uint32_t Level,
    uint32_t PrefMaxLen,
    uint8_t** Buffer,
    uint32_t* EntriesRead,
    uint32_t* ResumeHandle);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetDfsEnum(DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle)
-- DfsName : LPWSTR
-- Level : DWORD
-- PrefMaxLen : DWORD
-- Buffer : BYTE** out
-- EntriesRead : DWORD* out
-- ResumeHandle : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetDfsEnum = lib.func('__stdcall', 'NetDfsEnum', 'uint32_t', ['str16', 'uint32_t', 'uint32_t', 'uint8_t *', 'uint32_t *', 'uint32_t *']);
// NetDfsEnum(DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle)
// DfsName : LPWSTR -> 'str16'
// Level : DWORD -> 'uint32_t'
// PrefMaxLen : DWORD -> 'uint32_t'
// Buffer : BYTE** out -> 'uint8_t *'
// EntriesRead : DWORD* out -> 'uint32_t *'
// ResumeHandle : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetDfsEnum: { parameters: ["buffer", "u32", "u32", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.NetDfsEnum(DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle)
// DfsName : LPWSTR -> "buffer"
// Level : DWORD -> "u32"
// PrefMaxLen : DWORD -> "u32"
// Buffer : BYTE** out -> "pointer"
// EntriesRead : DWORD* out -> "pointer"
// ResumeHandle : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetDfsEnum(
    const uint16_t* DfsName,
    uint32_t Level,
    uint32_t PrefMaxLen,
    uint8_t** Buffer,
    uint32_t* EntriesRead,
    uint32_t* ResumeHandle);
C, "NETAPI32.dll");
// $ffi->NetDfsEnum(DfsName, Level, PrefMaxLen, Buffer, EntriesRead, ResumeHandle);
// DfsName : LPWSTR
// Level : DWORD
// PrefMaxLen : DWORD
// Buffer : BYTE** out
// EntriesRead : DWORD* out
// ResumeHandle : 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 Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
    int NetDfsEnum(
        WString DfsName,   // LPWSTR
        int Level,   // DWORD
        int PrefMaxLen,   // DWORD
        Pointer Buffer,   // BYTE** out
        IntByReference EntriesRead,   // DWORD* out
        IntByReference ResumeHandle   // DWORD* in/out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetDfsEnum = NetDfsEnum(
    DfsName : UInt16*,   # LPWSTR
    Level : UInt32,   # DWORD
    PrefMaxLen : UInt32,   # DWORD
    Buffer : UInt8**,   # BYTE** out
    EntriesRead : UInt32*,   # DWORD* out
    ResumeHandle : 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 NetDfsEnumNative = Uint32 Function(Pointer<Utf16>, Uint32, Uint32, Pointer<Uint8>, Pointer<Uint32>, Pointer<Uint32>);
typedef NetDfsEnumDart = int Function(Pointer<Utf16>, int, int, Pointer<Uint8>, Pointer<Uint32>, Pointer<Uint32>);
final NetDfsEnum = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetDfsEnumNative, NetDfsEnumDart>('NetDfsEnum');
// DfsName : LPWSTR -> Pointer<Utf16>
// Level : DWORD -> Uint32
// PrefMaxLen : DWORD -> Uint32
// Buffer : BYTE** out -> Pointer<Uint8>
// EntriesRead : DWORD* out -> Pointer<Uint32>
// ResumeHandle : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetDfsEnum(
  DfsName: PWideChar;   // LPWSTR
  Level: DWORD;   // DWORD
  PrefMaxLen: DWORD;   // DWORD
  Buffer: Pointer;   // BYTE** out
  EntriesRead: Pointer;   // DWORD* out
  ResumeHandle: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetDfsEnum';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetDfsEnum"
  c_NetDfsEnum :: CWString -> Word32 -> Word32 -> Ptr Word8 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- DfsName : LPWSTR -> CWString
-- Level : DWORD -> Word32
-- PrefMaxLen : DWORD -> Word32
-- Buffer : BYTE** out -> Ptr Word8
-- EntriesRead : DWORD* out -> Ptr Word32
-- ResumeHandle : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netdfsenum =
  foreign "NetDfsEnum"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* DfsName : LPWSTR -> (ptr uint16_t) *)
(* Level : DWORD -> uint32_t *)
(* PrefMaxLen : DWORD -> uint32_t *)
(* Buffer : BYTE** out -> (ptr uint8_t) *)
(* EntriesRead : DWORD* out -> (ptr uint32_t) *)
(* ResumeHandle : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetDfsEnum" net-dfs-enum :convention :stdcall) :uint32
  (dfs-name (:string :encoding :utf-16le))   ; LPWSTR
  (level :uint32)   ; DWORD
  (pref-max-len :uint32)   ; DWORD
  (buffer :pointer)   ; BYTE** out
  (entries-read :pointer)   ; DWORD* out
  (resume-handle :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetDfsEnum = Win32::API::More->new('NETAPI32',
    'DWORD NetDfsEnum(LPCWSTR DfsName, DWORD Level, DWORD PrefMaxLen, LPVOID Buffer, LPVOID EntriesRead, LPVOID ResumeHandle)');
# my $ret = $NetDfsEnum->Call($DfsName, $Level, $PrefMaxLen, $Buffer, $EntriesRead, $ResumeHandle);
# DfsName : LPWSTR -> LPCWSTR
# Level : DWORD -> DWORD
# PrefMaxLen : DWORD -> DWORD
# Buffer : BYTE** out -> LPVOID
# EntriesRead : DWORD* out -> LPVOID
# ResumeHandle : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。