NetFileEnum

関数

サーバーで開かれている共有ファイルを列挙する。

DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NetFileEnum(
    LPWSTR servername,   // optional
    LPWSTR basepath,   // optional
    LPWSTR username,   // optional
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    UINT_PTR* resume_handle   // optional
);

パラメーター

名前	型	方向
servername	LPWSTR	inoptional
basepath	LPWSTR	inoptional
username	LPWSTR	inoptional
level	DWORD	in
bufptr	BYTE**	out
prefmaxlen	DWORD	in
entriesread	DWORD*	out
totalentries	DWORD*	out
resume_handle	UINT_PTR*	inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD NetFileEnum(
    LPWSTR servername,   // optional
    LPWSTR basepath,   // optional
    LPWSTR username,   // optional
    DWORD level,
    BYTE** bufptr,
    DWORD prefmaxlen,
    DWORD* entriesread,
    DWORD* totalentries,
    UINT_PTR* resume_handle   // optional
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetFileEnum(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string basepath,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string username,   // LPWSTR optional
    uint level,   // DWORD
    IntPtr bufptr,   // BYTE** out
    uint prefmaxlen,   // DWORD
    out uint entriesread,   // DWORD* out
    out uint totalentries,   // DWORD* out
    IntPtr resume_handle   // UINT_PTR* optional, in/out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetFileEnum(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> basepath As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> username As String,   ' LPWSTR optional
    level As UInteger,   ' DWORD
    bufptr As IntPtr,   ' BYTE** out
    prefmaxlen As UInteger,   ' DWORD
    <Out> ByRef entriesread As UInteger,   ' DWORD* out
    <Out> ByRef totalentries As UInteger,   ' DWORD* out
    resume_handle As IntPtr   ' UINT_PTR* optional, in/out
) As UInteger
End Function

' servername : LPWSTR optional
' basepath : LPWSTR optional
' username : LPWSTR optional
' level : DWORD
' bufptr : BYTE** out
' prefmaxlen : DWORD
' entriesread : DWORD* out
' totalentries : DWORD* out
' resume_handle : UINT_PTR* optional, in/out
Declare PtrSafe Function NetFileEnum Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal basepath As LongPtr, _
    ByVal username As LongPtr, _
    ByVal level As Long, _
    ByVal bufptr As LongPtr, _
    ByVal prefmaxlen As Long, _
    ByRef entriesread As Long, _
    ByRef totalentries As Long, _
    ByVal resume_handle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetFileEnum = ctypes.windll.netapi32.NetFileEnum
NetFileEnum.restype = wintypes.DWORD
NetFileEnum.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.LPCWSTR,  # basepath : LPWSTR optional
    wintypes.LPCWSTR,  # username : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
    wintypes.DWORD,  # prefmaxlen : DWORD
    ctypes.POINTER(wintypes.DWORD),  # entriesread : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # totalentries : DWORD* out
    ctypes.POINTER(ctypes.c_size_t),  # resume_handle : UINT_PTR* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetFileEnum = Fiddle::Function.new(
  lib['NetFileEnum'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # basepath : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # username : LPWSTR optional
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE** out
    -Fiddle::TYPE_INT,  # prefmaxlen : DWORD
    Fiddle::TYPE_VOIDP,  # entriesread : DWORD* out
    Fiddle::TYPE_VOIDP,  # totalentries : DWORD* out
    Fiddle::TYPE_VOIDP,  # resume_handle : UINT_PTR* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetFileEnum(
        servername: *mut u16,  // LPWSTR optional
        basepath: *mut u16,  // LPWSTR optional
        username: *mut u16,  // LPWSTR optional
        level: u32,  // DWORD
        bufptr: *mut *mut u8,  // BYTE** out
        prefmaxlen: u32,  // DWORD
        entriesread: *mut u32,  // DWORD* out
        totalentries: *mut u32,  // DWORD* out
        resume_handle: *mut usize  // UINT_PTR* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetFileEnum([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string basepath, [MarshalAs(UnmanagedType.LPWStr)] string username, uint level, IntPtr bufptr, uint prefmaxlen, out uint entriesread, out uint totalentries, IntPtr resume_handle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetFileEnum' -Namespace Win32 -PassThru
# $api::NetFileEnum(servername, basepath, username, level, bufptr, prefmaxlen, entriesread, totalentries, resume_handle)

#uselib "NETAPI32.dll"
#func global NetFileEnum "NetFileEnum" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; NetFileEnum servername, basepath, username, level, varptr(bufptr), prefmaxlen, varptr(entriesread), varptr(totalentries), varptr(resume_handle)   ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; basepath : LPWSTR optional -> "sptr"
; username : LPWSTR optional -> "sptr"
; level : DWORD -> "sptr"
; bufptr : BYTE** out -> "sptr"
; prefmaxlen : DWORD -> "sptr"
; entriesread : DWORD* out -> "sptr"
; totalentries : DWORD* out -> "sptr"
; resume_handle : UINT_PTR* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NETAPI32.dll"
#cfunc global NetFileEnum "NetFileEnum" wstr, wstr, wstr, int, var, int, var, var, var
; res = NetFileEnum(servername, basepath, username, level, bufptr, prefmaxlen, entriesread, totalentries, resume_handle)
; servername : LPWSTR optional -> "wstr"
; basepath : LPWSTR optional -> "wstr"
; username : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "var"
; prefmaxlen : DWORD -> "int"
; entriesread : DWORD* out -> "var"
; totalentries : DWORD* out -> "var"
; resume_handle : UINT_PTR* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetFileEnum "NetFileEnum" wstr, wstr, wstr, int, sptr, int, sptr, sptr, sptr
; res = NetFileEnum(servername, basepath, username, level, varptr(bufptr), prefmaxlen, varptr(entriesread), varptr(totalentries), varptr(resume_handle))
; servername : LPWSTR optional -> "wstr"
; basepath : LPWSTR optional -> "wstr"
; username : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "sptr"
; prefmaxlen : DWORD -> "int"
; entriesread : DWORD* out -> "sptr"
; totalentries : DWORD* out -> "sptr"
; resume_handle : UINT_PTR* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD NetFileEnum(LPWSTR servername, LPWSTR basepath, LPWSTR username, DWORD level, BYTE** bufptr, DWORD prefmaxlen, DWORD* entriesread, DWORD* totalentries, UINT_PTR* resume_handle)
#uselib "NETAPI32.dll"
#cfunc global NetFileEnum "NetFileEnum" wstr, wstr, wstr, int, var, int, var, var, var
; res = NetFileEnum(servername, basepath, username, level, bufptr, prefmaxlen, entriesread, totalentries, resume_handle)
; servername : LPWSTR optional -> "wstr"
; basepath : LPWSTR optional -> "wstr"
; username : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "var"
; prefmaxlen : DWORD -> "int"
; entriesread : DWORD* out -> "var"
; totalentries : DWORD* out -> "var"
; resume_handle : UINT_PTR* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD NetFileEnum(LPWSTR servername, LPWSTR basepath, LPWSTR username, DWORD level, BYTE** bufptr, DWORD prefmaxlen, DWORD* entriesread, DWORD* totalentries, UINT_PTR* resume_handle)
#uselib "NETAPI32.dll"
#cfunc global NetFileEnum "NetFileEnum" wstr, wstr, wstr, int, intptr, int, intptr, intptr, intptr
; res = NetFileEnum(servername, basepath, username, level, varptr(bufptr), prefmaxlen, varptr(entriesread), varptr(totalentries), varptr(resume_handle))
; servername : LPWSTR optional -> "wstr"
; basepath : LPWSTR optional -> "wstr"
; username : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; bufptr : BYTE** out -> "intptr"
; prefmaxlen : DWORD -> "int"
; entriesread : DWORD* out -> "intptr"
; totalentries : DWORD* out -> "intptr"
; resume_handle : UINT_PTR* optional, in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetFileEnum = netapi32.NewProc("NetFileEnum")
)

// servername (LPWSTR optional), basepath (LPWSTR optional), username (LPWSTR optional), level (DWORD), bufptr (BYTE** out), prefmaxlen (DWORD), entriesread (DWORD* out), totalentries (DWORD* out), resume_handle (UINT_PTR* optional, in/out)
r1, _, err := procNetFileEnum.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(basepath))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(username))),
	uintptr(level),
	uintptr(bufptr),
	uintptr(prefmaxlen),
	uintptr(entriesread),
	uintptr(totalentries),
	uintptr(resume_handle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function NetFileEnum(
  servername: PWideChar;   // LPWSTR optional
  basepath: PWideChar;   // LPWSTR optional
  username: PWideChar;   // LPWSTR optional
  level: DWORD;   // DWORD
  bufptr: Pointer;   // BYTE** out
  prefmaxlen: DWORD;   // DWORD
  entriesread: Pointer;   // DWORD* out
  totalentries: Pointer;   // DWORD* out
  resume_handle: Pointer   // UINT_PTR* optional, in/out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetFileEnum';

result := DllCall("NETAPI32\NetFileEnum"
    , "WStr", servername   ; LPWSTR optional
    , "WStr", basepath   ; LPWSTR optional
    , "WStr", username   ; LPWSTR optional
    , "UInt", level   ; DWORD
    , "Ptr", bufptr   ; BYTE** out
    , "UInt", prefmaxlen   ; DWORD
    , "Ptr", entriesread   ; DWORD* out
    , "Ptr", totalentries   ; DWORD* out
    , "Ptr", resume_handle   ; UINT_PTR* optional, in/out
    , "UInt")   ; return: DWORD

●NetFileEnum(servername, basepath, username, level, bufptr, prefmaxlen, entriesread, totalentries, resume_handle) = DLL("NETAPI32.dll", "dword NetFileEnum(char*, char*, char*, dword, void*, dword, void*, void*, void*)")
# 呼び出し: NetFileEnum(servername, basepath, username, level, bufptr, prefmaxlen, entriesread, totalentries, resume_handle)
# servername : LPWSTR optional -> "char*"
# basepath : LPWSTR optional -> "char*"
# username : LPWSTR optional -> "char*"
# level : DWORD -> "dword"
# bufptr : BYTE** out -> "void*"
# prefmaxlen : DWORD -> "dword"
# entriesread : DWORD* out -> "void*"
# totalentries : DWORD* out -> "void*"
# resume_handle : UINT_PTR* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。