ホーム › Storage.FileSystem › NetFileGetInfo

NetFileGetInfo

関数

サーバーで開かれている共有ファイルの情報を取得する。

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

シグネチャ

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

DWORD NetFileGetInfo(
    LPWSTR servername,   // optional
    DWORD fileid,
    DWORD level,
    BYTE** bufptr
);

パラメーター

名前

型

方向

説明

servername

LPWSTR

inoptional

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

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

fileid

DWORD

情報を返す対象となるオープン済みリソースのファイル識別子を指定します。このパラメーターの値は、以前の列挙呼び出しで返されたものでなければなりません。詳細については、後述の「解説」セクションを参照してください。

level

DWORD

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

Value	Meaning
2	ファイル識別番号を返します。bufptr パラメーターは FILE_INFO_2 構造体へのポインターです。
3	ファイル識別番号と、ファイルに関するその他の情報を返します。bufptr パラメーターは FILE_INFO_3 構造体へのポインターです。

bufptr

BYTE**

out

情報を受け取るバッファーのアドレスへのポインター。このデータの形式は、level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

サーバーリソースの特定のオープン状態に関する情報を取得します。

戻り値

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

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

Return code	Description
ERROR_ACCESS_DENIED	ユーザーに要求された情報へのアクセス権がありません。
ERROR_FILE_NOT_FOUND	ファイルが見つかりませんでした。
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
ERROR_NOT_ENOUGH_MEMORY	使用可能なメモリが不足しています。
NERR_BufTooSmall	指定されたバッファーが小さすぎます。

解説(Remarks)

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

サーバー上で開かれている複数のファイルに関する情報を取得するには、 NetFileEnum 関数を呼び出すことができます。

Active Directory 向けにプログラミングを行っている場合は、特定の Active Directory Service Interface (ADSI) メソッドを呼び出すことで、 NetFileGetInfo の呼び出しによって実現できる機能と同じ機能を実現できる場合があります。詳細については、 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 NetFileGetInfo(
    LPWSTR servername,   // optional
    DWORD fileid,
    DWORD level,
    BYTE** bufptr
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetFileGetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    uint fileid,   // DWORD
    uint level,   // DWORD
    IntPtr bufptr   // BYTE** out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetFileGetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    fileid As UInteger,   ' DWORD
    level As UInteger,   ' DWORD
    bufptr As IntPtr   ' BYTE** out
) As UInteger
End Function

' servername : LPWSTR optional
' fileid : DWORD
' level : DWORD
' bufptr : BYTE** out
Declare PtrSafe Function NetFileGetInfo Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal fileid As Long, _
    ByVal level As Long, _
    ByVal bufptr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetFileGetInfo = ctypes.windll.netapi32.NetFileGetInfo
NetFileGetInfo.restype = wintypes.DWORD
NetFileGetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.DWORD,  # fileid : DWORD
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetFileGetInfo = Fiddle::Function.new(
  lib['NetFileGetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    -Fiddle::TYPE_INT,  # fileid : DWORD
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # bufptr : BYTE** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetFileGetInfo(
        servername: *mut u16,  // LPWSTR optional
        fileid: u32,  // DWORD
        level: u32,  // DWORD
        bufptr: *mut *mut u8  // BYTE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetFileGetInfo([MarshalAs(UnmanagedType.LPWStr)] string servername, uint fileid, uint level, IntPtr bufptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetFileGetInfo' -Namespace Win32 -PassThru
# $api::NetFileGetInfo(servername, fileid, level, bufptr)

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

出力引数:

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