ホーム › 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
);

パラメーター

名前	型	方向	説明
DfsName	LPWSTR	in	DFS ルートまたは DFS リンクの汎用名前付け規則 (UNC) パスを指定する文字列へのポインターです。情報レベル 200 (DFS_INFO_200) を指定する場合、このパラメーターはドメインの名前です。情報レベル 300 (DFS_INFO_300) を指定する場合、このパラメーターはサーバーの名前です。それ以外のすべてのレベルでは、文字列は次の 4 つの形式のいずれかを取ります。 ServerName\DfsName または ServerName\DfsName\link_path ここで ServerName はスタンドアロン DFS 名前空間をホストするルートターゲットサーバーの名前、 Dfsname は DFS 名前空間の名前、 link_path は DFS リンクです。文字列は次の形式を取ることもできます。 DomainName\DomainName\DomDfsName または DomainName\DomDfsName\link_path ここで DomainName はドメインベースの DFS ルートをホストするドメインの名前、 DomDfsName は DFS 名前空間の名前、 link_path は DFS リンクです。文字列の先頭に円記号 (\) を付けることもできますが、必須ではありません。このパラメーターは必須です。
Level	DWORD	in	要求の情報レベルを指定します。このパラメーターには次のいずれかの値を指定できます。 1 DFS ルートの名前と、ルート配下のすべてのリンクを返します。Buffer パラメーターは DFS_INFO_1 構造体の配列を指します。 2 DFS ルートとルート配下のすべてのリンクについて、名前、コメント、状態、およびターゲット数を返します。Buffer パラメーターは DFS_INFO_2 構造体の配列を指します。 3 DFS ルートとルート配下のすべてのリンクについて、名前、コメント、状態、ターゲット数、および各ターゲットに関する情報を返します。Buffer パラメーターは DFS_INFO_3 構造体の配列を指します。 4 DFS ルートとルート配下のすべてのリンクについて、名前、コメント、状態、GUID、タイムアウト、ターゲット数、および各ターゲットに関する情報を返します。Buffer パラメーターは DFS_INFO_4 構造体の配列を指します。 5 DFS ルートとルート配下のすべてのリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、およびターゲット数を返します。Buffer パラメーターは DFS_INFO_5 構造体の配列を指します。 6 名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、ルートまたはリンクの DFS ターゲット情報、および DFS ターゲットの一覧を返します。Buffer パラメーターは DFS_INFO_6 構造体の配列を指します。 8 DFS ルートとルート配下のすべてのリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、ターゲット数、およびリンクの再解析ポイントのセキュリティ記述子を返します。 Buffer パラメーターは DFS_INFO_8 構造体の配列を指します。 9 ルートまたはリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、DFS ターゲット情報、リンクの再解析ポイントのセキュリティ記述子、および DFS ターゲットの一覧を返します。 Buffer パラメーターは DFS_INFO_9 構造体の配列を指します。 200 ドメイン内のドメインベース DFS 名前空間の一覧を返します。Buffer パラメーターは DFS_INFO_200 構造体の配列を指します。 300 サーバーがホストするスタンドアロンおよびドメインベースの DFS 名前空間を返します。 Buffer パラメーターは DFS_INFO_300 構造体の配列を指します。
PrefMaxLen	DWORD	in	この関数が情報構造体バッファーに返すバイト数を指定します。このパラメーターが MAX_PREFERRED_LENGTH の場合、この関数はデータに必要な量のメモリを割り当てます。詳細については、後述の「解説」のセクションを参照してください。レベル 200 またはレベル 300 を指定した場合、このパラメーターは無視されます。
Buffer	BYTE**	out	要求した情報構造体を受け取るバッファーへのポインターです。このデータの形式は Level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられるため、 NetApiBufferFree 関数を使用して解放する必要があります。
EntriesRead	DWORD*	out	応答で返されたエントリの実際の数を受け取る値へのポインターです。
ResumeHandle	DWORD*	inout	この関数の 1 回の呼び出しで返せる量を超えるデータがある場合に、列挙を継続するために使用するハンドルを格納する値へのポインターです。最初の呼び出しではこのハンドルを 0 にし、以降の呼び出しでは変更せずにそのまま渡す必要があります。詳細については、後述の「解説」のセクションを参照してください。

戻り値の型: DWORD

公式ドキュメント

サーバー上でホストされている分散ファイルシステム (DFS) の名前空間、またはサーバーがホストする名前空間の DFS リンクを列挙します。

戻り値

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

列挙できるエントリがこれ以上ない場合、戻り値は ERROR_NO_MORE_ITEMS です。

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの一覧については、 System Error Codes を参照してください。

解説(Remarks)

NetDfsEnum 関数を使用するために、特別なグループのメンバーシップは必要ありません。

列挙を開始するには、ResumeHandle パラメーターに 0 を設定して NetDfsEnum 関数を呼び出します。列挙操作を継続するには、前回の NetDfsEnum の呼び出しで返された ResumeHandle を指定してこの関数を呼び出します。この関数が ERROR_NO_MORE_ITEMS を返さない場合、この API を続けて呼び出すことで残りのリンクが返されます。ERROR_NO_MORE_ITEMS が返された時点で、利用可能なすべての DFS リンクが取得されたことになります。

NetDfsEnum 関数は、情報構造体バッファーに必要なメモリを割り当てます。PrefMaxLen パラメーターにサイズを指定すると、この関数が返すメモリが制限されます。ただし、NetDfsEnum 関数が実際に割り当てるメモリのサイズは、指定した量より大きくなる場合があります。詳細については、 Network Management Function Buffer Lengths を参照してください。

DFS 名前空間が同時に更新される可能性があるため、呼び出し元は、列挙操作を再開して得られた結果が完全である、または一意であると想定しないでください。

例

次のサンプルコードは、NetDfsEnum 関数を呼び出して、指定した DFS ルート内の DFS リンクを一覧表示する方法を示します。このサンプルでは、情報レベル 3 ( DFS_INFO_3) を指定して NetDfsEnum を呼び出します。サンプルコードはエントリをループ処理し、取得したデータと、DFS リンクが参照する各ホストサーバーの状態を出力します。最後に、情報バッファーに割り当てられたメモリを解放します。

#include <windows.h>
#include <lm.h>
#include <lmdfs.h>
#include <stdio.h>

#pragma comment(lib, "Netapi32.lib")

void wmain(int argc, wchar_t *argv[ ])
{
    PDFS_INFO_3 pData, p;
    PDFS_STORAGE_INFO ps;
    DWORD er = 0, hResume = 0, res, i, j;

    if(argc < 2)
        wprintf(L"Syntax: %s \\\\DfsName\n", argv[0]);
    else
    {
        //
        // レベル 3 を指定して NetDfsEnum 関数を呼び出します。
        //
        res = NetDfsEnum(argv[1], 3, MAX_PREFERRED_LENGTH, (LPBYTE *) &pData, &er, &hResume);

        // 利用可能なすべてのエントリが返されるまで NetDfsEnum を呼び出します。
        // すべてのエントリを取得すると、NetDfsEnum は 
        // ERROR_NO_MORE_ITEMS を返します。
        while (res == ERROR_SUCCESS)
        {
            p = pData;
            //
            // エントリをループ処理し、データを出力します。
            //
            for(i = 1; i <= er; i++)
            {
                printf("%-30S%u\n", p->EntryPath, p->NumberOfStorages);
                ps = p->Storage;
                //
                // 各ターゲットをループ処理します。
                //
                for(j = 1; j <= p->NumberOfStorages; j++)
                {
                    //
                    // DFS リンクが参照する各ターゲットの状態 (Offline/Online) と
                    // 名前を出力します。
                    //
                    printf("    %S  ", (ps->State == DFS_STORAGE_STATE_OFFLINE) ? TEXT("Offline"):TEXT("Online "));
                    printf("\\\\%S\\%S\n", ps->ServerName, ps->ShareName);
                    ps++;
                }
                p++;
            }
            // 割り当てられたバッファーを解放します。
            //
            NetApiBufferFree(pData);


            res = NetDfsEnum(argv[1], 3, MAX_PREFERRED_LENGTH, (LPBYTE *) &pData, &er, &hResume);
        }


        if (res == ERROR_NO_MORE_ITEMS)
        {
            // 最後のエントリまで処理が完了しました。
            res = ERROR_SUCCESS;
            printf("Enumeration done\n");
        } 
        else 
        {
            // エラーが発生しました。
            printf("Error: %u\n", res);
        }
    }
    return;
}

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

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetDfsEnum "NetDfsEnum" wstr, int, int, sptr, sptr, sptr
; res = NetDfsEnum(DfsName, Level, PrefMaxLen, varptr(Buffer), varptr(EntriesRead), varptr(ResumeHandle))
; DfsName : LPWSTR -> "wstr"
; Level : DWORD -> "int"
; PrefMaxLen : DWORD -> "int"
; Buffer : BYTE** out -> "sptr"
; EntriesRead : DWORD* out -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。