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

CreateSymbolicLinkTransactedA

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOLEAN CreateSymbolicLinkTransactedA(
    LPCSTR lpSymlinkFileName,
    LPCSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags,
    HANDLE hTransaction
);

パラメーター

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

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

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

dwFlagsSYMBOLIC_LINK_FLAGSin

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

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

戻り値の型: BOOLEAN

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

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

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。
Technology Supported
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  (ANSI / -A)
#include <windows.h>

BOOLEAN CreateSymbolicLinkTransactedA(
    LPCSTR lpSymlinkFileName,
    LPCSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags,
    HANDLE hTransaction
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateSymbolicLinkTransactedA(
    [MarshalAs(UnmanagedType.LPStr)] string lpSymlinkFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpTargetFileName,   // LPCSTR
    uint dwFlags,   // SYMBOLIC_LINK_FLAGS
    IntPtr hTransaction   // HANDLE
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateSymbolicLinkTransactedA(
    <MarshalAs(UnmanagedType.LPStr)> lpSymlinkFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpTargetFileName As String,   ' LPCSTR
    dwFlags As UInteger,   ' SYMBOLIC_LINK_FLAGS
    hTransaction As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' lpSymlinkFileName : LPCSTR
' lpTargetFileName : LPCSTR
' dwFlags : SYMBOLIC_LINK_FLAGS
' hTransaction : HANDLE
Declare PtrSafe Function CreateSymbolicLinkTransactedA Lib "kernel32" ( _
    ByVal lpSymlinkFileName As String, _
    ByVal lpTargetFileName As String, _
    ByVal dwFlags As Long, _
    ByVal hTransaction As LongPtr) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateSymbolicLinkTransactedA = ctypes.windll.kernel32.CreateSymbolicLinkTransactedA
CreateSymbolicLinkTransactedA.restype = wintypes.BOOLEAN
CreateSymbolicLinkTransactedA.argtypes = [
    wintypes.LPCSTR,  # lpSymlinkFileName : LPCSTR
    wintypes.LPCSTR,  # lpTargetFileName : LPCSTR
    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')
CreateSymbolicLinkTransactedA = Fiddle::Function.new(
  lib['CreateSymbolicLinkTransactedA'],
  [
    Fiddle::TYPE_VOIDP,  # lpSymlinkFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpTargetFileName : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : SYMBOLIC_LINK_FLAGS
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  Fiddle::TYPE_CHAR)
#[link(name = "kernel32")]
extern "system" {
    fn CreateSymbolicLinkTransactedA(
        lpSymlinkFileName: *const u8,  // LPCSTR
        lpTargetFileName: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool CreateSymbolicLinkTransactedA([MarshalAs(UnmanagedType.LPStr)] string lpSymlinkFileName, [MarshalAs(UnmanagedType.LPStr)] string lpTargetFileName, uint dwFlags, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateSymbolicLinkTransactedA' -Namespace Win32 -PassThru
# $api::CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
#uselib "KERNEL32.dll"
#func global CreateSymbolicLinkTransactedA "CreateSymbolicLinkTransactedA" sptr, sptr, sptr, sptr
; CreateSymbolicLinkTransactedA lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction   ; 戻り値は stat
; lpSymlinkFileName : LPCSTR -> "sptr"
; lpTargetFileName : LPCSTR -> "sptr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateSymbolicLinkTransactedA "CreateSymbolicLinkTransactedA" str, str, int, sptr
; res = CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
; lpSymlinkFileName : LPCSTR -> "str"
; lpTargetFileName : LPCSTR -> "str"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "int"
; hTransaction : HANDLE -> "sptr"
; BOOLEAN CreateSymbolicLinkTransactedA(LPCSTR lpSymlinkFileName, LPCSTR lpTargetFileName, SYMBOLIC_LINK_FLAGS dwFlags, HANDLE hTransaction)
#uselib "KERNEL32.dll"
#cfunc global CreateSymbolicLinkTransactedA "CreateSymbolicLinkTransactedA" str, str, int, intptr
; res = CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
; lpSymlinkFileName : LPCSTR -> "str"
; lpTargetFileName : LPCSTR -> "str"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "int"
; hTransaction : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateSymbolicLinkTransactedA = kernel32.NewProc("CreateSymbolicLinkTransactedA")
)

// lpSymlinkFileName (LPCSTR), lpTargetFileName (LPCSTR), dwFlags (SYMBOLIC_LINK_FLAGS), hTransaction (HANDLE)
r1, _, err := procCreateSymbolicLinkTransactedA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSymlinkFileName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpTargetFileName))),
	uintptr(dwFlags),
	uintptr(hTransaction),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOLEAN
function CreateSymbolicLinkTransactedA(
  lpSymlinkFileName: PAnsiChar;   // LPCSTR
  lpTargetFileName: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // SYMBOLIC_LINK_FLAGS
  hTransaction: THandle   // HANDLE
): ByteBool; stdcall;
  external 'KERNEL32.dll' name 'CreateSymbolicLinkTransactedA';
result := DllCall("KERNEL32\CreateSymbolicLinkTransactedA"
    , "AStr", lpSymlinkFileName   ; LPCSTR
    , "AStr", lpTargetFileName   ; LPCSTR
    , "UInt", dwFlags   ; SYMBOLIC_LINK_FLAGS
    , "Ptr", hTransaction   ; HANDLE
    , "Char")   ; return: BOOLEAN
●CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction) = DLL("KERNEL32.dll", "byte CreateSymbolicLinkTransactedA(char*, char*, dword, void*)")
# 呼び出し: CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
# lpSymlinkFileName : LPCSTR -> "char*"
# lpTargetFileName : LPCSTR -> "char*"
# dwFlags : SYMBOLIC_LINK_FLAGS -> "dword"
# hTransaction : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn CreateSymbolicLinkTransactedA(
    lpSymlinkFileName: [*c]const u8, // LPCSTR
    lpTargetFileName: [*c]const u8, // LPCSTR
    dwFlags: u32, // SYMBOLIC_LINK_FLAGS
    hTransaction: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) u8;
proc CreateSymbolicLinkTransactedA(
    lpSymlinkFileName: cstring,  # LPCSTR
    lpTargetFileName: cstring,  # LPCSTR
    dwFlags: uint32,  # SYMBOLIC_LINK_FLAGS
    hTransaction: pointer  # HANDLE
): uint8 {.importc: "CreateSymbolicLinkTransactedA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
ubyte CreateSymbolicLinkTransactedA(
    const(char)* lpSymlinkFileName,   // LPCSTR
    const(char)* lpTargetFileName,   // LPCSTR
    uint dwFlags,   // SYMBOLIC_LINK_FLAGS
    void* hTransaction   // HANDLE
);
ccall((:CreateSymbolicLinkTransactedA, "KERNEL32.dll"), stdcall, UInt8,
      (Cstring, Cstring, UInt32, Ptr{Cvoid}),
      lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
# lpSymlinkFileName : LPCSTR -> Cstring
# lpTargetFileName : LPCSTR -> Cstring
# dwFlags : SYMBOLIC_LINK_FLAGS -> UInt32
# hTransaction : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint8_t CreateSymbolicLinkTransactedA(
    const char* lpSymlinkFileName,
    const char* lpTargetFileName,
    uint32_t dwFlags,
    void* hTransaction);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
-- lpSymlinkFileName : LPCSTR
-- lpTargetFileName : LPCSTR
-- dwFlags : SYMBOLIC_LINK_FLAGS
-- hTransaction : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateSymbolicLinkTransactedA = lib.func('__stdcall', 'CreateSymbolicLinkTransactedA', 'uint8_t', ['str', 'str', 'uint32_t', 'void *']);
// CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
// lpSymlinkFileName : LPCSTR -> 'str'
// lpTargetFileName : LPCSTR -> 'str'
// dwFlags : SYMBOLIC_LINK_FLAGS -> 'uint32_t'
// hTransaction : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateSymbolicLinkTransactedA: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "u8" },
});
// lib.symbols.CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction)
// lpSymlinkFileName : LPCSTR -> "buffer"
// lpTargetFileName : LPCSTR -> "buffer"
// dwFlags : SYMBOLIC_LINK_FLAGS -> "u32"
// hTransaction : HANDLE -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t CreateSymbolicLinkTransactedA(
    const char* lpSymlinkFileName,
    const char* lpTargetFileName,
    uint32_t dwFlags,
    void* hTransaction);
C, "KERNEL32.dll");
// $ffi->CreateSymbolicLinkTransactedA(lpSymlinkFileName, lpTargetFileName, dwFlags, hTransaction);
// lpSymlinkFileName : LPCSTR
// lpTargetFileName : LPCSTR
// 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.ASCII_OPTIONS);
    byte CreateSymbolicLinkTransactedA(
        String lpSymlinkFileName,   // LPCSTR
        String lpTargetFileName,   // LPCSTR
        int dwFlags,   // SYMBOLIC_LINK_FLAGS
        Pointer hTransaction   // HANDLE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateSymbolicLinkTransactedA = CreateSymbolicLinkTransactedA(
    lpSymlinkFileName : UInt8*,   # LPCSTR
    lpTargetFileName : UInt8*,   # LPCSTR
    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 CreateSymbolicLinkTransactedANative = Uint8 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>);
typedef CreateSymbolicLinkTransactedADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>);
final CreateSymbolicLinkTransactedA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateSymbolicLinkTransactedANative, CreateSymbolicLinkTransactedADart>('CreateSymbolicLinkTransactedA');
// lpSymlinkFileName : LPCSTR -> Pointer<Utf8>
// lpTargetFileName : LPCSTR -> Pointer<Utf8>
// dwFlags : SYMBOLIC_LINK_FLAGS -> Uint32
// hTransaction : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateSymbolicLinkTransactedA(
  lpSymlinkFileName: PAnsiChar;   // LPCSTR
  lpTargetFileName: PAnsiChar;   // LPCSTR
  dwFlags: DWORD;   // SYMBOLIC_LINK_FLAGS
  hTransaction: THandle   // HANDLE
): ByteBool; stdcall;
  external 'KERNEL32.dll' name 'CreateSymbolicLinkTransactedA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let createsymboliclinktransacteda =
  foreign "CreateSymbolicLinkTransactedA"
    (string @-> string @-> uint32_t @-> (ptr void) @-> returning uint8_t)
(* lpSymlinkFileName : LPCSTR -> string *)
(* lpTargetFileName : LPCSTR -> string *)
(* 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 ("CreateSymbolicLinkTransactedA" create-symbolic-link-transacted-a :convention :stdcall) :uint8
  (lp-symlink-file-name :string)   ; LPCSTR
  (lp-target-file-name :string)   ; LPCSTR
  (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 $CreateSymbolicLinkTransactedA = Win32::API::More->new('KERNEL32',
    'BYTE CreateSymbolicLinkTransactedA(LPCSTR lpSymlinkFileName, LPCSTR lpTargetFileName, DWORD dwFlags, HANDLE hTransaction)');
# my $ret = $CreateSymbolicLinkTransactedA->Call($lpSymlinkFileName, $lpTargetFileName, $dwFlags, $hTransaction);
# lpSymlinkFileName : LPCSTR -> LPCSTR
# lpTargetFileName : LPCSTR -> LPCSTR
# dwFlags : SYMBOLIC_LINK_FLAGS -> DWORD
# hTransaction : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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