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

CreateSymbolicLinkTransactedW

関数
トランザクション内でシンボリックリンクを作成する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOLEAN CreateSymbolicLinkTransactedW(
    LPCWSTR lpSymlinkFileName,
    LPCWSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags,
    HANDLE hTransaction
);

パラメーター

名前方向説明
lpSymlinkFileNameLPCWSTRin作成するシンボリックリンク。
lpTargetFileNameLPCWSTRin

作成するシンボリックリンクのターゲット名。

lpTargetFileName にデバイス名が関連付けられている場合、リンクは 絶対リンクとして扱われます。それ以外の場合、リンクは相対リンクとして扱われます。

dwFlagsSYMBOLIC_LINK_FLAGSin

リンクターゲット lpTargetFileName がディレクトリかどうかを示します。

意味
0x0
リンクターゲットはファイルです。
SYMBOLIC_LINK_FLAG_DIRECTORY
0x1
リンクターゲットはディレクトリです。
hTransactionHANDLEinトランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: BOOLEAN

公式ドキュメント

シンボリックリンクをトランザクション操作として作成します。(Unicode)

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

シンボリックリンクは絶対リンクまたは相対リンクのいずれかになります。絶対リンクはパス名の各部分を 指定するリンクです。相対リンクは、指定されたパス内の相対リンク指定子の位置を基準として 決定されます。相対リンクは次の規則を使用して指定します。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。
テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル いいえ
SMB 3.0 Transparent Failover (TFO) いいえ
SMB 3.0 with Scale-out File Shares (SO) いいえ
Cluster Shared Volume File System (CsvFS) いいえ
Resilient File System (ReFS) いいえ

SMB 3.0 は TxF をサポートしていません。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CreateSymbolicLinkTransacted を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOLEAN CreateSymbolicLinkTransactedW(
    LPCWSTR lpSymlinkFileName,
    LPCWSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags,
    HANDLE hTransaction
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CreateSymbolicLinkTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpSymlinkFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpTargetFileName,   // LPCWSTR
    uint dwFlags,   // SYMBOLIC_LINK_FLAGS
    IntPtr hTransaction   // HANDLE
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateSymbolicLinkTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpSymlinkFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpTargetFileName As String,   ' LPCWSTR
    dwFlags As UInteger,   ' SYMBOLIC_LINK_FLAGS
    hTransaction As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' lpSymlinkFileName : LPCWSTR
' lpTargetFileName : LPCWSTR
' dwFlags : SYMBOLIC_LINK_FLAGS
' hTransaction : HANDLE
Declare PtrSafe Function CreateSymbolicLinkTransactedW Lib "kernel32" ( _
    ByVal lpSymlinkFileName As LongPtr, _
    ByVal lpTargetFileName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal hTransaction As LongPtr) As Byte
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateSymbolicLinkTransactedW = ctypes.windll.kernel32.CreateSymbolicLinkTransactedW
CreateSymbolicLinkTransactedW.restype = wintypes.BOOLEAN
CreateSymbolicLinkTransactedW.argtypes = [
    wintypes.LPCWSTR,  # lpSymlinkFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpTargetFileName : LPCWSTR
    wintypes.DWORD,  # dwFlags : SYMBOLIC_LINK_FLAGS
    wintypes.HANDLE,  # hTransaction : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateSymbolicLinkTransactedW = Fiddle::Function.new(
  lib['CreateSymbolicLinkTransactedW'],
  [
    Fiddle::TYPE_VOIDP,  # lpSymlinkFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpTargetFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : SYMBOLIC_LINK_FLAGS
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  Fiddle::TYPE_CHAR)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn CreateSymbolicLinkTransactedW(
        lpSymlinkFileName: *const u16,  // LPCWSTR
        lpTargetFileName: *const u16,  // LPCWSTR
        dwFlags: u32,  // SYMBOLIC_LINK_FLAGS
        hTransaction: *mut core::ffi::c_void  // HANDLE
    ) -> u8;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CreateSymbolicLinkTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpSymlinkFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpTargetFileName, uint dwFlags, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateSymbolicLinkTransactedW' -Namespace Win32 -PassThru
# $api::CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
#uselib "KERNEL32.dll"
#func global CreateSymbolicLinkTransactedW "CreateSymbolicLinkTransactedW" wptr, wptr, wptr, wptr
; CreateSymbolicLinkTransactedW lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction   ; 戻り値は stat
; lpSymlinkFileName : LPCWSTR -> "wptr"
; lpTargetFileName : LPCWSTR -> "wptr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "wptr"
; hTransaction : HANDLE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateSymbolicLinkTransactedW "CreateSymbolicLinkTransactedW" wstr, wstr, int, sptr
; res = CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
; lpSymlinkFileName : LPCWSTR -> "wstr"
; lpTargetFileName : LPCWSTR -> "wstr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "int"
; hTransaction : HANDLE -> "sptr"
; BOOLEAN CreateSymbolicLinkTransactedW(LPCWSTR lpSymlinkFileName, LPCWSTR lpTargetFileName, SYMBOLIC_LINK_FLAGS dwFlags, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global CreateSymbolicLinkTransactedW "CreateSymbolicLinkTransactedW" wstr, wstr, int, intptr
; res = CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
; lpSymlinkFileName : LPCWSTR -> "wstr"
; lpTargetFileName : LPCWSTR -> "wstr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "int"
; hTransaction : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateSymbolicLinkTransactedW = kernel32.NewProc("CreateSymbolicLinkTransactedW")
)

// lpSymlinkFileName (LPCWSTR), lpTargetFileName (LPCWSTR), dwFlags (SYMBOLIC_LINK_FLAGS), hTransaction (HANDLE)
r1, _, err := procCreateSymbolicLinkTransactedW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpSymlinkFileName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpTargetFileName))),
	uintptr(dwFlags),
	uintptr(hTransaction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN
function CreateSymbolicLinkTransactedW(
  lpSymlinkFileName: PWideChar;   // LPCWSTR
  lpTargetFileName: PWideChar;   // LPCWSTR
  dwFlags: DWORD;   // SYMBOLIC_LINK_FLAGS
  hTransaction: THandle   // HANDLE
): ByteBool; stdcall;
  external 'KERNEL32.dll' name 'CreateSymbolicLinkTransactedW';
result := DllCall("KERNEL32\CreateSymbolicLinkTransactedW"
    , "WStr", lpSymlinkFileName   ; LPCWSTR
    , "WStr", lpTargetFileName   ; LPCWSTR
    , "UInt", dwFlags   ; SYMBOLIC_LINK_FLAGS
    , "Ptr", hTransaction   ; HANDLE
    , "Char")   ; return: BOOLEAN
●CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction) = DLL("KERNEL32.dll", "byte CreateSymbolicLinkTransactedW(char*, char*, dword, void*)")
# 呼び出し: CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
# lpSymlinkFileName : LPCWSTR -> "char*"
# lpTargetFileName : LPCWSTR -> "char*"
# dwFlags : SYMBOLIC_LINK_FLAGS -> "dword"
# hTransaction : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn CreateSymbolicLinkTransactedW(
    lpSymlinkFileName: [*c]const u16, // LPCWSTR
    lpTargetFileName: [*c]const u16, // LPCWSTR
    dwFlags: u32, // SYMBOLIC_LINK_FLAGS
    hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) u8;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CreateSymbolicLinkTransactedW(
    lpSymlinkFileName: WideCString,  # LPCWSTR
    lpTargetFileName: WideCString,  # LPCWSTR
    dwFlags: uint32,  # SYMBOLIC_LINK_FLAGS
    hTransaction: pointer  # HANDLE
): uint8 {.importc: "CreateSymbolicLinkTransactedW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
ubyte CreateSymbolicLinkTransactedW(
    const(wchar)* lpSymlinkFileName,   // LPCWSTR
    const(wchar)* lpTargetFileName,   // LPCWSTR
    uint dwFlags,   // SYMBOLIC_LINK_FLAGS
    void* hTransaction   // HANDLE
);
ccall((:CreateSymbolicLinkTransactedW, "KERNEL32.dll"), stdcall, UInt8,
      (Cwstring, Cwstring, UInt32, Ptr{Cvoid}),
      lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
# lpSymlinkFileName : LPCWSTR -> Cwstring
# lpTargetFileName : LPCWSTR -> Cwstring
# dwFlags : SYMBOLIC_LINK_FLAGS -> UInt32
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint8_t CreateSymbolicLinkTransactedW(
    const uint16_t* lpSymlinkFileName,
    const uint16_t* lpTargetFileName,
    uint32_t dwFlags,
    void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
-- lpSymlinkFileName : LPCWSTR
-- lpTargetFileName : LPCWSTR
-- dwFlags : SYMBOLIC_LINK_FLAGS
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateSymbolicLinkTransactedW = lib.func('__stdcall', 'CreateSymbolicLinkTransactedW', 'uint8_t', ['str16', 'str16', 'uint32_t', 'void *']);
// CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
// lpSymlinkFileName : LPCWSTR -> 'str16'
// lpTargetFileName : LPCWSTR -> 'str16'
// dwFlags : SYMBOLIC_LINK_FLAGS -> 'uint32_t'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateSymbolicLinkTransactedW: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "u8" },
});
// lib.symbols.CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
// lpSymlinkFileName : LPCWSTR -> "buffer"
// lpTargetFileName : LPCWSTR -> "buffer"
// dwFlags : SYMBOLIC_LINK_FLAGS -> "u32"
// hTransaction : HANDLE -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t CreateSymbolicLinkTransactedW(
    const uint16_t* lpSymlinkFileName,
    const uint16_t* lpTargetFileName,
    uint32_t dwFlags,
    void* hTransaction);
C, "KERNEL32.dll");
// $ffi->CreateSymbolicLinkTransactedW(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction);
// lpSymlinkFileName : LPCWSTR
// lpTargetFileName : LPCWSTR
// dwFlags : SYMBOLIC_LINK_FLAGS
// hTransaction : HANDLE
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    byte CreateSymbolicLinkTransactedW(
        WString lpSymlinkFileName,   // LPCWSTR
        WString lpTargetFileName,   // LPCWSTR
        int dwFlags,   // SYMBOLIC_LINK_FLAGS
        Pointer hTransaction   // HANDLE
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateSymbolicLinkTransactedW = CreateSymbolicLinkTransactedW(
    lpSymlinkFileName : UInt16*,   # LPCWSTR
    lpTargetFileName : UInt16*,   # LPCWSTR
    dwFlags : UInt32,   # SYMBOLIC_LINK_FLAGS
    hTransaction : Void*   # HANDLE
  ) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateSymbolicLinkTransactedWNative = Uint8 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Void>);
typedef CreateSymbolicLinkTransactedWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Void>);
final CreateSymbolicLinkTransactedW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateSymbolicLinkTransactedWNative, CreateSymbolicLinkTransactedWDart>('CreateSymbolicLinkTransactedW');
// lpSymlinkFileName : LPCWSTR -> Pointer<Utf16>
// lpTargetFileName : LPCWSTR -> Pointer<Utf16>
// dwFlags : SYMBOLIC_LINK_FLAGS -> Uint32
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateSymbolicLinkTransactedW(
  lpSymlinkFileName: PWideChar;   // LPCWSTR
  lpTargetFileName: PWideChar;   // LPCWSTR
  dwFlags: DWORD;   // SYMBOLIC_LINK_FLAGS
  hTransaction: THandle   // HANDLE
): ByteBool; stdcall;
  external 'KERNEL32.dll' name 'CreateSymbolicLinkTransactedW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateSymbolicLinkTransactedW"
  c_CreateSymbolicLinkTransactedW :: CWString -> CWString -> Word32 -> Ptr () -> IO Word8
-- lpSymlinkFileName : LPCWSTR -> CWString
-- lpTargetFileName : LPCWSTR -> CWString
-- dwFlags : SYMBOLIC_LINK_FLAGS -> Word32
-- hTransaction : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createsymboliclinktransactedw =
  foreign "CreateSymbolicLinkTransactedW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning uint8_t)
(* lpSymlinkFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpTargetFileName : LPCWSTR -> (ptr uint16_t) *)
(* dwFlags : SYMBOLIC_LINK_FLAGS -> uint32_t *)
(* hTransaction : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateSymbolicLinkTransactedW" create-symbolic-link-transacted-w :convention :stdcall) :uint8
  (lp-symlink-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-target-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-flags :uint32)   ; SYMBOLIC_LINK_FLAGS
  (h-transaction :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateSymbolicLinkTransactedW = Win32::API::More->new('KERNEL32',
    'BYTE CreateSymbolicLinkTransactedW(LPCWSTR lpSymlinkFileName, LPCWSTR lpTargetFileName, DWORD dwFlags, HANDLE hTransaction)');
# my $ret = $CreateSymbolicLinkTransactedW->Call($lpSymlinkFileName, $lpTargetFileName, $dwFlags, $hTransaction);
# lpSymlinkFileName : LPCWSTR -> LPCWSTR
# lpTargetFileName : LPCWSTR -> LPCWSTR
# dwFlags : SYMBOLIC_LINK_FLAGS -> DWORD
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型