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

NetFileEnum

関数
サーバーで開かれている共有ファイルを列挙する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
servernameLPWSTRinoptional

関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインター。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode です。

basepathLPWSTRinoptional

返される情報の修飾子を指定する文字列へのポインター。このパラメーターが NULL の場合は、開かれているすべてのリソースが列挙されます。このパラメーターが NULL でない場合、関数は basepath パラメーターの値をプレフィックスとして持つリソースのみを列挙します。(プレフィックスとは、パスのうちバックスラッシュより前の部分です。)

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode です。

usernameLPWSTRinoptional

ユーザー名または接続名を指定する文字列へのポインター。文字列が 2 個のバックスラッシュ（"\"）で始まる場合は、接続名を表します。例えば "\127.0.0.1" や "\ClientName" などです。接続名のうちバックスラッシュより後の部分は、NetSessionEnum 関数が返すセッション情報構造体のクライアント名と同じです。文字列が 2 個のバックスラッシュで始まらない場合は、ユーザー名を表します。このパラメーターが NULL でない場合、その値は列挙の修飾子として機能します。返されるファイルは、ユーザー名または接続名がこの修飾子に一致するものに限定されます。このパラメーターが NULL の場合、ユーザー名修飾子は使用されません。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP の場合: このパラメーターはユーザー名を指定する文字列へのポインターです。このパラメーターが NULL でない場合、その値は列挙の修飾子として機能します。返されるファイルは、ユーザー名がこの修飾子に一致するものに限定されます。このパラメーターが NULL の場合、ユーザー名修飾子は使用されません。

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode です。

levelDWORDin

データの情報レベルを指定します。このパラメーターには次のいずれかの値を指定できます。

値 意味
2
 ファイル識別番号を返します。bufptr パラメーターは FILE_INFO_2 構造体の配列を指します。
3
 ファイルに関する情報を返します。bufptr パラメーターは FILE_INFO_3 構造体の配列を指します。
bufptrBYTE**out

情報を受け取るバッファーのアドレスへのポインター。このデータの形式は level パラメーターの値によって異なります。

このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。関数が ERROR_MORE_DATA で失敗した場合でも、バッファーを解放する必要があることに注意してください。

prefmaxlenDWORDin返されるデータの推奨される最大長をバイト単位で指定します。MAX_PREFERRED_LENGTH を指定した場合、関数はデータに必要な量のメモリを割り当てます。このパラメーターに別の値を指定した場合、関数が返すバイト数が制限されることがあります。バッファーサイズがすべてのエントリを保持するのに不十分な場合、関数は ERROR_MORE_DATA を返します。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。
entriesreadDWORD*out実際に列挙された要素の数を受け取る値へのポインター。
totalentriesDWORD*out現在の再開位置から列挙され得たエントリの総数を受け取る値へのポインター。アプリケーションはこの値をあくまで目安として扱うべきであることに注意してください。
resume_handleUINT_PTR*inoutoptional既存のファイル検索を続行するために使用される再開ハンドルを格納する値へのポインター。このハンドルは最初の呼び出しではゼロにし、以降の呼び出しでは変更しないでください。このパラメーターが NULL の場合、再開ハンドルは格納されません。

戻り値の型: DWORD

公式ドキュメント

指定したパラメーターに応じて、サーバー上で開かれている一部またはすべてのファイルに関する情報を返します。

戻り値

関数が成功した場合、戻り値は NERR_Success です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻りコード 説明
ERROR_ACCESS_DENIED
 ユーザーが要求された情報にアクセスする権限を持っていません。
ERROR_INVALID_LEVEL
 level パラメーターに指定された値が無効です。
ERROR_MORE_DATA
 さらに多くのエントリが利用可能です。すべてのエントリを受け取るのに十分な大きさのバッファーを指定してください。
ERROR_NOT_ENOUGH_MEMORY
 使用可能なメモリが不足しています。
NERR_BufTooSmall
 指定されたバッファーが小さすぎます。

解説(Remarks)

NetFileEnum 関数を正常に実行できるのは、Administrators または Server Operators ローカルグループのメンバーのみです。

NetFileGetInfo 関数を呼び出すと、サーバーリソースの特定のオープンに関する情報を取得できます。

Active Directory 向けにプログラミングを行っている場合は、特定の Active Directory Service Interface (ADSI) メソッドを呼び出すことで、 NetFileEnum を呼び出して実現できるのと同じ機能を実現できることがあります。詳細については、 IADsResource および IADsFileServiceOperations を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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)。
const std = @import("std");

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

foreign import stdcall safe "NetFileEnum"
  c_NetFileEnum :: CWString -> CWString -> CWString -> Word32 -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr CUIntPtr -> IO Word32
-- servername : LPWSTR optional -> CWString
-- basepath : LPWSTR optional -> CWString
-- username : LPWSTR optional -> CWString
-- level : DWORD -> Word32
-- bufptr : BYTE** out -> Ptr Word8
-- prefmaxlen : DWORD -> Word32
-- entriesread : DWORD* out -> Ptr Word32
-- totalentries : DWORD* out -> Ptr Word32
-- resume_handle : UINT_PTR* optional, in/out -> Ptr CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netfileenum =
  foreign "NetFileEnum"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr size_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* basepath : LPWSTR optional -> (ptr uint16_t) *)
(* username : LPWSTR optional -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : BYTE** out -> (ptr uint8_t) *)
(* prefmaxlen : DWORD -> uint32_t *)
(* entriesread : DWORD* out -> (ptr uint32_t) *)
(* totalentries : DWORD* out -> (ptr uint32_t) *)
(* resume_handle : UINT_PTR* optional, in/out -> (ptr size_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetFileEnum" net-file-enum :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (basepath (:string :encoding :utf-16le))   ; LPWSTR optional
  (username (:string :encoding :utf-16le))   ; LPWSTR optional
  (level :uint32)   ; DWORD
  (bufptr :pointer)   ; BYTE** out
  (prefmaxlen :uint32)   ; DWORD
  (entriesread :pointer)   ; DWORD* out
  (totalentries :pointer)   ; DWORD* out
  (resume-handle :pointer))   ; UINT_PTR* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetFileEnum = Win32::API::More->new('NETAPI32',
    'DWORD NetFileEnum(LPCWSTR servername, LPCWSTR basepath, LPCWSTR username, DWORD level, LPVOID bufptr, DWORD prefmaxlen, LPVOID entriesread, LPVOID totalentries, LPVOID resume_handle)');
# my $ret = $NetFileEnum->Call($servername, $basepath, $username, $level, $bufptr, $prefmaxlen, $entriesread, $totalentries, $resume_handle);
# servername : LPWSTR optional -> LPCWSTR
# basepath : LPWSTR optional -> LPCWSTR
# username : LPWSTR optional -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE** out -> LPVOID
# prefmaxlen : DWORD -> DWORD
# entriesread : DWORD* out -> LPVOID
# totalentries : DWORD* out -> LPVOID
# resume_handle : UINT_PTR* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目