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

NetDfsMove

関数
DFSリンクを別のパスへ移動または改名する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD NetDfsMove(
    LPWSTR OldDfsEntryPath,
    LPWSTR NewDfsEntryPath,
    DWORD Flags
);

パラメーター

名前型方向説明
OldDfsEntryPathLPWSTRin移動操作の移動元パスを指定する文字列へのポインター。この値は、DFS リンク、または DFS 名前空間内のいずれかの DFS リンクのパスプレフィックスである必要があります。
NewDfsEntryPathLPWSTRin移動操作の移動先パスを指定する文字列へのポインター。この値は、同じ DFS 名前空間内のパスまたは DFS リンクである必要があります。
FlagsDWORDin

リンクの移動時に実行する動作を示すフラグのセット。

DFS_MOVE_FLAG_REPLACE_IF_EXISTS (0x00000001)

移動先のパスが既存の DFS リンクである場合、移動操作の一部としてそのリンクを置き換えます。

戻り値の型: DWORD

公式ドキュメント

DFS リンクの名前を変更、または移動します。

戻り値

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

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

解説(Remarks)

NetDfsMove 関数を使用すると、リンクを古い名前から新しい名前へ簡単に移動できます。従来は、誤ったリンクや古いリンクを削除して新しいリンクを作成するという手間のかかる操作が必要でしたが、リンクのターゲット数が多い場合や、ターゲットごとのプロパティ (優先度など) が設定されている場合、この作業は煩雑になります。また、管理者がリンクの名前変更や移動を日常的に行うこともよくあります。

NetDfsMove に指定する DFS パスは、実際の DFS リンクでも、DFS リンクのパスプレフィックスでもかまいません。ワイルドカードは使用できず、絶対パスのみを指定できます。相対パスや特殊なパス名構文 ("." や ".." など) は使用できません。

完全な DFS パスではなく DFS リンクのパスプレフィックスを指定した場合、そのプレフィックスを含むすべての DFS リンクに対して移動操作が実行されます。したがって、NetDfsMove を 1 回呼び出すだけで複数のリンクを「移動」できます。ただし、パスプレフィックスは少なくとも 1 つの有効な DFS リンクに解決される必要があり、解決されない場合、移動操作は失敗します。

次の例は、さまざまな移動操作とその結果を示しています。

    • 移動元パス: \\MyDfsServer\MyDfsShare\dir1\dir2\link1
    • 移動先パス: \\MyDfsServer\MyDfsShare\dir1\dir2\link2
    移動後、\\MyDfsServer\MyDfsShare\dir1\dir2\link1 は \\MyDfsServer\MyDfsShare\dir1\dir2\link2 に置き換えられます。
    • 移動元パス: \\MyDfsServer\MyDfsShare\dir1\dir2\link1
    • 移動先パス: \\MyDfsServer\MyDfsShare\dir3\dir4\dir5\link2
    移動後、\\MyDfsServer\MyDfsShare\dir1\dir2\link1 は \\MyDfsServer\MyDfsShare\dir3\dir4\dir5\link2 に置き換えられます。リーフ部分と非リーフ部分の両方の名前が変更されており、新しいパスの構成要素の数も変化している点に注意してください。
    • 移動元パス: \\MyDfsServer\MyDfsShare\dir1
    • 移動先パス: \\MyDfsServer\MyDfsShare\dir3
    移動後、\\MyDfsServer\MyDfsShare\dir1 をプレフィックスとするすべてのリンクで、そのプレフィックスが \\MyDfsServer\MyDfsShare\dir3 に置き換えられます。したがって、\\MyDfsServer\MyDfsShare\dir1\dir2\link1 と \\MyDfsServer\MyDfsShare\dir1\dir2\link2 は、それぞれ \\MyDfsServer\MyDfsShare\dir3\dir2\link1 と \\MyDfsServer\MyDfsShare\dir3\dir2\link1 になります。
    • 移動元パス: \\MyDfsServer\MyDfsShare\dir1
    • 移動先パス: \\MyDfsServer\MyDfsShare
    移動後、\\MyDfsServer\MyDfsShare\dir1 をプレフィックスとするすべてのリンクで、そのプレフィックスが \\MyDfsServer\MyDfsShare に置き換えられます。したがって、\\MyDfsServer\MyDfsShare\dir1\dir2\link1 と \\MyDfsServer\MyDfsShare\dir1\dir2\link2 は、それぞれ \\MyDfsServer\MyDfsShare\dir2\link1 と \\MyDfsServer\MyDfsShare\dir2\link1 になります。
移動先のパスに既存のエントリがある場合、新しいパスで古いパスを上書きするには DFS_MOVE_FLAG_REPLACE_IF_EXISTS を指定する必要があります。このフラグが設定されている場合、衝突したパスは削除され、新しいリンクに置き換えられます。なお、完全に重複する DFS リンクが生じる可能性のある操作は、DFS_MOVE_FLAG_REPLACE_IF_EXISTS が指定されているかどうかにかかわらず失敗します。次に例を示します。 この移動操作が成功したとすると、結果として \\MyDfsServer\MyDfsShare\link3\link1 と \\MyDfsServer\MyDfsShare\link3 という、完全に重複する 2 つのリンクが生じます。したがって、この移動操作は失敗する必要があります。

ドメインベースの DFS サーバーでは、移動操作はアトミックです。つまり、操作全体が実行されるか、失敗するかのいずれかになります。一方、スタンドアロンの DFS サーバーでは、移動操作がアトミックであることは保証されません。この場合、失敗すると移動操作が部分的にのみ完了した状態になることがあり、呼び出し元アプリケーション側でのクリーンアップが必要になります。

移動操作が成功した場合、DFS メタデータが正常に変更されたことは保証されます。ただし、ルートターゲット上に DFS リンクが実際に作成されたことや、ルートターゲットのストレージ上に DFS リンクを作成できることが保証されるわけではありません。

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

各言語での呼び出し定義

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

DWORD NetDfsMove(
    LPWSTR OldDfsEntryPath,
    LPWSTR NewDfsEntryPath,
    DWORD Flags
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetDfsMove(
    [MarshalAs(UnmanagedType.LPWStr)] string OldDfsEntryPath,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string NewDfsEntryPath,   // LPWSTR
    uint Flags   // DWORD
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetDfsMove(
    <MarshalAs(UnmanagedType.LPWStr)> OldDfsEntryPath As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> NewDfsEntryPath As String,   ' LPWSTR
    Flags As UInteger   ' DWORD
) As UInteger
End Function
' OldDfsEntryPath : LPWSTR
' NewDfsEntryPath : LPWSTR
' Flags : DWORD
Declare PtrSafe Function NetDfsMove Lib "netapi32" ( _
    ByVal OldDfsEntryPath As LongPtr, _
    ByVal NewDfsEntryPath As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetDfsMove = ctypes.windll.netapi32.NetDfsMove
NetDfsMove.restype = wintypes.DWORD
NetDfsMove.argtypes = [
    wintypes.LPCWSTR,  # OldDfsEntryPath : LPWSTR
    wintypes.LPCWSTR,  # NewDfsEntryPath : LPWSTR
    wintypes.DWORD,  # Flags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetDfsMove = Fiddle::Function.new(
  lib['NetDfsMove'],
  [
    Fiddle::TYPE_VOIDP,  # OldDfsEntryPath : LPWSTR
    Fiddle::TYPE_VOIDP,  # NewDfsEntryPath : LPWSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetDfsMove(
        OldDfsEntryPath: *mut u16,  // LPWSTR
        NewDfsEntryPath: *mut u16,  // LPWSTR
        Flags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetDfsMove([MarshalAs(UnmanagedType.LPWStr)] string OldDfsEntryPath, [MarshalAs(UnmanagedType.LPWStr)] string NewDfsEntryPath, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetDfsMove' -Namespace Win32 -PassThru
# $api::NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
#uselib "NETAPI32.dll"
#func global NetDfsMove "NetDfsMove" sptr, sptr, sptr
; NetDfsMove OldDfsEntryPath, NewDfsEntryPath, Flags   ; 戻り値は stat
; OldDfsEntryPath : LPWSTR -> "sptr"
; NewDfsEntryPath : LPWSTR -> "sptr"
; Flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "NETAPI32.dll"
#cfunc global NetDfsMove "NetDfsMove" wstr, wstr, int
; res = NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
; OldDfsEntryPath : LPWSTR -> "wstr"
; NewDfsEntryPath : LPWSTR -> "wstr"
; Flags : DWORD -> "int"
; DWORD NetDfsMove(LPWSTR OldDfsEntryPath, LPWSTR NewDfsEntryPath, DWORD Flags)
#uselib "NETAPI32.dll"
#cfunc global NetDfsMove "NetDfsMove" wstr, wstr, int
; res = NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
; OldDfsEntryPath : LPWSTR -> "wstr"
; NewDfsEntryPath : LPWSTR -> "wstr"
; Flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetDfsMove = netapi32.NewProc("NetDfsMove")
)

// OldDfsEntryPath (LPWSTR), NewDfsEntryPath (LPWSTR), Flags (DWORD)
r1, _, err := procNetDfsMove.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(OldDfsEntryPath))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(NewDfsEntryPath))),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetDfsMove(
  OldDfsEntryPath: PWideChar;   // LPWSTR
  NewDfsEntryPath: PWideChar;   // LPWSTR
  Flags: DWORD   // DWORD
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetDfsMove';
result := DllCall("NETAPI32\NetDfsMove"
    , "WStr", OldDfsEntryPath   ; LPWSTR
    , "WStr", NewDfsEntryPath   ; LPWSTR
    , "UInt", Flags   ; DWORD
    , "UInt")   ; return: DWORD
●NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags) = DLL("NETAPI32.dll", "dword NetDfsMove(char*, char*, dword)")
# 呼び出し: NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
# OldDfsEntryPath : LPWSTR -> "char*"
# NewDfsEntryPath : LPWSTR -> "char*"
# Flags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn NetDfsMove(
    OldDfsEntryPath: [*c]const u16, // LPWSTR
    NewDfsEntryPath: [*c]const u16, // LPWSTR
    Flags: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc NetDfsMove(
    OldDfsEntryPath: WideCString,  # LPWSTR
    NewDfsEntryPath: WideCString,  # LPWSTR
    Flags: uint32  # DWORD
): uint32 {.importc: "NetDfsMove", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetDfsMove(
    const(wchar)* OldDfsEntryPath,   // LPWSTR
    const(wchar)* NewDfsEntryPath,   // LPWSTR
    uint Flags   // DWORD
);
ccall((:NetDfsMove, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, UInt32),
      OldDfsEntryPath, NewDfsEntryPath, Flags)
# OldDfsEntryPath : LPWSTR -> Cwstring
# NewDfsEntryPath : LPWSTR -> Cwstring
# Flags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetDfsMove(
    const uint16_t* OldDfsEntryPath,
    const uint16_t* NewDfsEntryPath,
    uint32_t Flags);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
-- OldDfsEntryPath : LPWSTR
-- NewDfsEntryPath : LPWSTR
-- Flags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetDfsMove = lib.func('__stdcall', 'NetDfsMove', 'uint32_t', ['str16', 'str16', 'uint32_t']);
// NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
// OldDfsEntryPath : LPWSTR -> 'str16'
// NewDfsEntryPath : LPWSTR -> 'str16'
// Flags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetDfsMove: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags)
// OldDfsEntryPath : LPWSTR -> "buffer"
// NewDfsEntryPath : LPWSTR -> "buffer"
// Flags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetDfsMove(
    const uint16_t* OldDfsEntryPath,
    const uint16_t* NewDfsEntryPath,
    uint32_t Flags);
C, "NETAPI32.dll");
// $ffi->NetDfsMove(OldDfsEntryPath, NewDfsEntryPath, Flags);
// OldDfsEntryPath : LPWSTR
// NewDfsEntryPath : LPWSTR
// Flags : DWORD
// 構造体/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 NetDfsMove(
        WString OldDfsEntryPath,   // LPWSTR
        WString NewDfsEntryPath,   // LPWSTR
        int Flags   // DWORD
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetDfsMove = NetDfsMove(
    OldDfsEntryPath : UInt16*,   # LPWSTR
    NewDfsEntryPath : UInt16*,   # LPWSTR
    Flags : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetDfsMoveNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef NetDfsMoveDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final NetDfsMove = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetDfsMoveNative, NetDfsMoveDart>('NetDfsMove');
// OldDfsEntryPath : LPWSTR -> Pointer<Utf16>
// NewDfsEntryPath : LPWSTR -> Pointer<Utf16>
// Flags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetDfsMove(
  OldDfsEntryPath: PWideChar;   // LPWSTR
  NewDfsEntryPath: PWideChar;   // LPWSTR
  Flags: DWORD   // DWORD
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetDfsMove';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetDfsMove"
  c_NetDfsMove :: CWString -> CWString -> Word32 -> IO Word32
-- OldDfsEntryPath : LPWSTR -> CWString
-- NewDfsEntryPath : LPWSTR -> CWString
-- Flags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netdfsmove =
  foreign "NetDfsMove"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* OldDfsEntryPath : LPWSTR -> (ptr uint16_t) *)
(* NewDfsEntryPath : LPWSTR -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetDfsMove" net-dfs-move :convention :stdcall) :uint32
  (old-dfs-entry-path (:string :encoding :utf-16le))   ; LPWSTR
  (new-dfs-entry-path (:string :encoding :utf-16le))   ; LPWSTR
  (flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetDfsMove = Win32::API::More->new('NETAPI32',
    'DWORD NetDfsMove(LPCWSTR OldDfsEntryPath, LPCWSTR NewDfsEntryPath, DWORD Flags)');
# my $ret = $NetDfsMove->Call($OldDfsEntryPath, $NewDfsEntryPath, $Flags);
# OldDfsEntryPath : LPWSTR -> LPCWSTR
# NewDfsEntryPath : LPWSTR -> LPCWSTR
# Flags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。