ホーム › Storage.DistributedFileSystem › NetDfsSetInfo

NetDfsSetInfo

関数

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

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

シグネチャ

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

DWORD NetDfsSetInfo(
    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	DFS リンクターゲットのサーバー名を指定する文字列へのポインター。このパラメーターは省略可能です。詳細については、「解説」セクションを参照してください。
ShareName	LPWSTR	inoptional	DFS リンクターゲットの共有名を指定する文字列へのポインター。共有に対する相対パスを含む共有名を指定することもできます。たとえば "share1\mydir1\mydir2" のように指定します。このパラメーターは省略可能です。詳細については、「解説」セクションを参照してください。
Level	DWORD	in	データの情報レベルを指定します。このパラメーターには、次のいずれかの値を指定できます。 100 DfsEntryPath パラメーターで指定した DFS のルートまたはリンクに関連付けられたコメントを設定します。Buffer パラメーターは DFS_INFO_100 構造体を指します。 101 DfsEntryPath パラメーターで指定した DFS のルートまたはリンクに関連付けられたストレージの状態を設定します。Buffer パラメーターは DFS_INFO_101 構造体を指します。 102 DfsEntryPath パラメーターで指定した DFS のルートまたはリンクに関連付けられたタイムアウト値を設定します。Buffer パラメーターは DFS_INFO_102 構造体を指します。 103 DfsEntryPath パラメーターで指定した DFS のルートまたはリンクのプロパティフラグを設定します。 Buffer パラメーターは DFS_INFO_103 構造体を指します。 104 DfsEntryPath パラメーターで指定したルートターゲットまたはリンクターゲットのターゲット優先順位のランクとクラスを設定します。Buffer パラメーターは DFS_INFO_104 構造体を指します。 105 DfsEntryPath パラメーターで指定した DFS のルートまたはリンクについて、コメント、状態、タイムアウト情報、およびプロパティフラグを設定します。Buffer パラメーターは DFS_INFO_105 構造体を指します。 106 DfsEntryPath パラメーターで指定したルートターゲットまたはリンクターゲットのターゲットの状態と優先順位を設定します。この情報は DFS 名前空間のルートやリンクには設定できず、ルートターゲットまたはリンクターゲットに対してのみ設定できます。Buffer パラメーターは DFS_INFO_106 構造体を指します。 107 DfsEntryPath パラメーターで指定した DFS のルートまたはリンクについて、コメント、状態、タイムアウト情報、およびプロパティフラグを設定します。DFS リンクの場合は、リンクの再解析ポイントのセキュリティ記述子も設定できます。Buffer パラメーターは DFS_INFO_107 構造体を指します。 150 DFS リンクの再解析ポイントのセキュリティ記述子を設定します。Buffer パラメーターは DFS_INFO_150 構造体を指します。
Buffer	BYTE*	in	データを指定するバッファーへのポインター。このデータの形式は Level パラメーターの値によって異なります。詳細については、 Network Management Function Buffers を参照してください。

戻り値の型: DWORD

公式ドキュメント

特定の分散ファイルシステム (DFS) のルート、ルートターゲット、リンク、またはリンクターゲットに関する情報を設定または変更します。

戻り値

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

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

解説(Remarks)

呼び出し元は DFS サーバーに対する Administrator 特権を持っている必要があります。管理者特権を必要とする関数の呼び出しの詳細については、 Running with Special Privileges を参照してください。

ServerName パラメーターと ShareName パラメーターの両方を指定した場合、 NetDfsSetInfo 関数はそのルートターゲットまたはリンクターゲットに固有の情報を設定または変更します。これらのパラメーターが NULL の場合、この関数は特定の DFS ルートターゲットやリンクターゲットではなく、 DFS 名前空間のルートまたは DFS リンクに固有の情報を設定または変更します。

DFS のルートまたはリンクに設定できるコメントとタイムアウトはそれぞれ 1 つだけであるため、情報レベル 100 および 102 では ServerName パラメーターと ShareName パラメーターは無視されます。これらのパラメーターはレベル 101 では必須です。

情報レベル 101 では、DFS 名前空間に複数の DFS ルートターゲットが存在する場合、特定のドメインベース DFS ルートに対して DFS_VOLUME_STATE_RESYNCHRONIZE および DFS_VOLUME_STATE_STANDBY の状態値を次のように設定できます。

DfsEntryPath パラメーターでドメインベースの DFS 名前空間を指定し、 ServerName パラメーターと ShareName パラメーターの組み合わせで、情報設定操作を実行する DFS ルートターゲットを指定します。

Examples

次のコードサンプルは、NetDfsSetInfo 関数の呼び出しによって DFS リンクにコメントを関連付ける方法を示しています。このサンプルでは情報レベル 100 (DFS_INFO_100) を指定しています。

#include <windows.h>
#include <lm.h>
#include <lmdfs.h>
#include <stdio.h>
#pragma comment(lib, "Netapi32.lib")

void wmain(int argc, wchar_t *argv[])
{
   DFS_INFO_100 dfsData;
   DWORD res;
   //
   // Check command line arguments.
   //
   if (argc<2)
      wprintf(L"Syntax: %s DfsEntryPath [\"Comment\"]\n", argv[0]);
   else
   {
      //
      // Fill in DFS_INFO_100 structure member.
      //
      dfsData.Comment = argc < 3 ? NULL : argv[2];
      //
      // Call the NetDfsSetInfo function, specifying level 100.
      //
      res = NetDfsSetInfo(argv[1], NULL, NULL, 100, (LPBYTE) &dfsData);
      //
      // Display the result of the call.
      //
      if(res == 0)
         printf("Comment set.\n");
      else
         printf("Error: %u", 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 NetDfsSetInfo(
    LPWSTR DfsEntryPath,
    LPWSTR ServerName,   // optional
    LPWSTR ShareName,   // optional
    DWORD Level,
    BYTE* Buffer
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetDfsSetInfo(
    [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*
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetDfsSetInfo(
    <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*
) As UInteger
End Function

' DfsEntryPath : LPWSTR
' ServerName : LPWSTR optional
' ShareName : LPWSTR optional
' Level : DWORD
' Buffer : BYTE*
Declare PtrSafe Function NetDfsSetInfo 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

NetDfsSetInfo = ctypes.windll.netapi32.NetDfsSetInfo
NetDfsSetInfo.restype = wintypes.DWORD
NetDfsSetInfo.argtypes = [
    wintypes.LPCWSTR,  # DfsEntryPath : LPWSTR
    wintypes.LPCWSTR,  # ServerName : LPWSTR optional
    wintypes.LPCWSTR,  # ShareName : LPWSTR optional
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetDfsSetInfo = Fiddle::Function.new(
  lib['NetDfsSetInfo'],
  [
    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*
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetDfsSetInfo([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_NetDfsSetInfo' -Namespace Win32 -PassThru
# $api::NetDfsSetInfo(DfsEntryPath, ServerName, ShareName, Level, Buffer)

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

出力引数:

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