ホーム › Storage.DistributedFileSystem › NetDfsGetInfo

NetDfsGetInfo

関数

指定DFSエントリの情報を取得する。

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

シグネチャ

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

DWORD NetDfsGetInfo(
    LPWSTR DfsEntryPath,
    LPWSTR ServerName,   // optional
    LPWSTR ShareName,   // optional
    DWORD Level,
    BYTE** Buffer
);

パラメーター

名前	型	方向	説明
DfsEntryPath	LPWSTR	in	DFS ルートまたはリンクの Universal Naming Convention (UNC) パスを指定する文字列へのポインターです。リンクの場合、文字列は 2 つの形式のいずれかを取ります。1 つ目の形式は次のとおりです。 \\ServerName\DfsName\link_path ここで ServerName はスタンドアロン DFS 名前空間をホストするルートターゲットサーバーの名前、DfsName は DFS 名前空間の名前、 link_path は DFS リンクです。 2 つ目の形式は次のとおりです。 \\DomainName\DomDfsname\link_path ここで DomainName はドメインベースの DFS 名前空間をホストするドメインの名前、 DomDfsname は DFS 名前空間の名前、 link_path は DFS リンクです。ルートの場合、文字列は次の 2 つの形式のいずれかを取ります。 \\ServerName\DfsName または \\DomainName\DomDfsname 各名前の値は前述のものと同じです。このパラメーターは必須です。
ServerName	LPWSTR	inoptional	このパラメーターは現在無視されます。NULL を指定してください。
ShareName	LPWSTR	inoptional	このパラメーターは現在無視されます。NULL を指定してください。
Level	DWORD	in	要求する情報レベルを指定します。このパラメーターには次のいずれかの値を指定できます。 1 DFS ルートまたは DFS リンクの名前を返します。Buffer パラメーターは DFS_INFO_1 構造体を指します。 2 DFS ルートまたは DFS リンクの名前、状態、および DFS ターゲットの数を返します。 Buffer パラメーターは DFS_INFO_2 構造体を指します。 3 DFS ルートまたは DFS リンクの名前、状態、およびターゲット情報を返します。 Buffer パラメーターは DFS_INFO_3 構造体を指します。 4 DFS ルートまたは DFS リンクの名前、状態、GUID、タイムアウト、およびターゲット情報を返します。 Buffer パラメーターは DFS_INFO_4 構造体を指します。 5 DFS ルートおよびそのルート配下のすべてのリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、およびターゲット数を返します。Buffer パラメーターは DFS_INFO_5 構造体の配列を指します。 6 ルートまたはリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、DFS ターゲット情報、および DFS ターゲットの一覧を返します。Buffer パラメーターは DFS_INFO_6 構造体の配列を指します。 7 DFS メタデータのバージョン番号 GUID を返します。Buffer パラメーターは DFS_INFO_7 構造体の配列を指します。 8 DFS ルートおよびそのルート配下のすべてのリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、ターゲット数、およびリンクの再解析ポイントのセキュリティ記述子を返します。Buffer パラメーターは DFS_INFO_8 構造体の配列を指します。 9 ルートまたはリンクについて、名前、状態、GUID、タイムアウト、プロパティフラグ、メタデータサイズ、DFS ターゲット情報、リンクの再解析ポイントのセキュリティ記述子、および DFS ターゲットの一覧を返します。 Buffer パラメーターは DFS_INFO_9 構造体の配列を指します。 50 既存の DFS 名前空間の DFS メタデータバージョンと機能を返します。 Buffer パラメーターは DFS_INFO_50 構造体を指します。 100 DFS ルートまたは DFS リンクのコメントを返します。Buffer パラメーターは DFS_INFO_100 構造体を指します。 150 DFS リンクの再解析ポイントのセキュリティ記述子を返します。Buffer パラメーターは DFS_INFO_150 構造体を指します。メモこの値がネイティブにサポートされるのは、DFS リンクが Windows Server 2008 以降を実行しているサーバー上に存在する場合のみです。
Buffer	BYTE**	out	要求された情報構造体を受け取るバッファーのアドレスへのポインターです。このデータの形式は Level パラメーターの値によって異なります。このバッファーはシステムによって割り当てられるため、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。

戻り値の型: DWORD

公式ドキュメント

DFS 名前空間内の指定された分散ファイルシステム (DFS) ルートまたはリンクに関する情報を取得します。

戻り値

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

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

解説(Remarks)

<b>NetDfsGetInfo</b> 関数を使用するために特別なグループ メンバーシップは必要ありません。

NetDfsGetInfo 関数を呼び出すアプリケーションは、この関数呼び出しを処理するローカルの DFS 名前空間サーバーに対して、そのドメインの PDC エミュレーターマスターから関連する名前空間メタデータの完全同期を間接的に実行させる場合があります。この完全同期は、その名前空間にルートスケーラビリティモードが構成されている場合でも発生する可能性があります。この副作用を避けるために、特定の DFS 名前空間パスに対応する、特定の DFSN クライアントコンピューターが使用する物理 UNC パス名のみを取得することが目的である場合は、 WDK API の ZwQueryInformationFile を使用する方法があります。その際、FileInformationClass パラメーターに FileNetworkPhysicalNameInformation を渡し、 FileInformation パラメーターには呼び出し側が割り当てた FILE_NETWORK_PHYSICAL_NAME_INFORMATION 構造体のアドレスを渡します。WDK API の呼び出しについて詳しくは、WDK を参照してください。

例

次のコードサンプルは、 NetDfsGetInfo 関数の呼び出しによって DFS リンクに関する情報を取得する方法を示しています。このサンプルは、情報レベル 3 (DFS_INFO_3) を指定して NetDfsGetInfo を呼び出します。呼び出しが成功すると、サンプルはリンクが参照する各ターゲットの名前と状態を含む、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;
   PDFS_STORAGE_INFO ps;
   DWORD er = 0, tr = 0, res, j;

   //
   // Check command line arguments.
   //
   if (argc<2)
      wprintf(L"Syntax: %s DfsEntryPath\n", argv[0]);
   else
   {
      //
      // Call the NetDfsGetInfo function, specifying level 3.
      //
      res = NetDfsGetInfo(argv[1], NULL, NULL, 3, (LPBYTE *) &pData);
      //
      // If the call succeeds, print the data.
      //
      if(res==0)
      {
         printf("%-30S Storages: %u\nComment: %S\n", pData->EntryPath, pData->NumberOfStorages, pData->Comment);
         ps = pData->Storage;
         //
         // Loop through each target.
         //
         for(j = 1; j <= pData->NumberOfStorages;j++)
         {
            //
            // Print the status (Offline/Online) and the name 
            // of each target referenced by the DFS link.
            //
            printf("    %S  ", (ps->State == DFS_STORAGE_STATE_OFFLINE) ? TEXT("Offline"): TEXT("Online "));
            printf("\\\\%S\\%S\n", ps->ServerName, ps->ShareName);
            ps++;
         }
         //
         // Free the allocated memory.
         //
         NetApiBufferFree(pData);
      }
      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 NetDfsGetInfo(
    LPWSTR DfsEntryPath,
    LPWSTR ServerName,   // optional
    LPWSTR ShareName,   // optional
    DWORD Level,
    BYTE** Buffer
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetDfsGetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string DfsEntryPath,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string ServerName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string ShareName,   // LPWSTR optional
    uint Level,   // DWORD
    IntPtr Buffer   // BYTE** out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetDfsGetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> DfsEntryPath As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> ServerName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> ShareName As String,   ' LPWSTR optional
    Level As UInteger,   ' DWORD
    Buffer As IntPtr   ' BYTE** out
) As UInteger
End Function

' DfsEntryPath : LPWSTR
' ServerName : LPWSTR optional
' ShareName : LPWSTR optional
' Level : DWORD
' Buffer : BYTE** out
Declare PtrSafe Function NetDfsGetInfo Lib "netapi32" ( _
    ByVal DfsEntryPath As LongPtr, _
    ByVal ServerName As LongPtr, _
    ByVal ShareName As LongPtr, _
    ByVal Level As Long, _
    ByVal Buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetDfsGetInfo = ctypes.windll.netapi32.NetDfsGetInfo
NetDfsGetInfo.restype = wintypes.DWORD
NetDfsGetInfo.argtypes = [
    wintypes.LPCWSTR,  # DfsEntryPath : LPWSTR
    wintypes.LPCWSTR,  # ServerName : LPWSTR optional
    wintypes.LPCWSTR,  # ShareName : LPWSTR optional
    wintypes.DWORD,  # Level : DWORD
    ctypes.c_void_p,  # Buffer : BYTE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetDfsGetInfo = Fiddle::Function.new(
  lib['NetDfsGetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # DfsEntryPath : LPWSTR
    Fiddle::TYPE_VOIDP,  # ServerName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # ShareName : LPWSTR optional
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetDfsGetInfo(
        DfsEntryPath: *mut u16,  // LPWSTR
        ServerName: *mut u16,  // LPWSTR optional
        ShareName: *mut u16,  // LPWSTR optional
        Level: u32,  // DWORD
        Buffer: *mut *mut u8  // BYTE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetDfsGetInfo([MarshalAs(UnmanagedType.LPWStr)] string DfsEntryPath, [MarshalAs(UnmanagedType.LPWStr)] string ServerName, [MarshalAs(UnmanagedType.LPWStr)] string ShareName, uint Level, IntPtr Buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetDfsGetInfo' -Namespace Win32 -PassThru
# $api::NetDfsGetInfo(DfsEntryPath, ServerName, ShareName, Level, Buffer)

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

出力引数:

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