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

CreateSymbolicLinkA

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

シグネチャ

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

BOOLEAN CreateSymbolicLinkA(
    LPCSTR lpSymlinkFileName,
    LPCSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags
);

パラメーター

名前方向説明
lpSymlinkFileNameLPCSTRin

作成するシンボリックリンクです。

このパラメーターにはパスを含めることができます。

既定では、名前は MAX_PATH 文字に制限されています。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付け の「最大パス長の制限」セクションを参照してください。

lpTargetFileNameLPCSTRin

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

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

このパラメーターにはパスを含めることができます。

既定では、名前は MAX_PATH 文字に制限されています。この制限を 32,767 ワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、名前空間の名前付けを参照してください。

ヒント

Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を解除するようにオプトインできます。詳細については、ファイル、パス、名前空間の名前付け の「最大パス長の制限」セクションを参照してください。

dwFlagsSYMBOLIC_LINK_FLAGSin

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

意味
0x0
リンクのターゲットはファイルです。
SYMBOLIC_LINK_FLAG_DIRECTORY
0x1
リンクのターゲットはディレクトリです。
SYMBOLIC_LINK_FLAG_ALLOW_UNPRIVILEGED_CREATE
0x2
プロセスが昇格していない状態でもシンボリックリンクの作成を許可するには、このフラグを指定します。UWP では、このオプションが機能する前に、マシン上で開発者モードを有効にしておく必要があります。MSIX では、このフラグのために開発者モードを有効にする必要はありません。

戻り値の型: BOOLEAN

公式ドキュメント

シンボリックリンクを作成します。(ANSI)

戻り値

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

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

解説(Remarks)

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

シンボリックリンクを削除するには、使用しているシンボリックリンクの種類に応じて、ファイルを削除する (DeleteFile または類似の API を使用) か、ディレクトリを削除します (RemoveDirectory または類似の API を使用)。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) はい
SMB 3.0 スケールアウトファイル共有 (SO) いいえ
クラスター共有ボリュームファイルシステム (CsvFS) いいえ
回復性のあるファイルシステム (ReFS) はい

CsvFs は、ソフトリンクやその他のリパースポイントをサポートしていません。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateSymbolicLinkA(
    LPCSTR lpSymlinkFileName,
    LPCSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateSymbolicLinkA(
    [MarshalAs(UnmanagedType.LPStr)] string lpSymlinkFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpTargetFileName,   // LPCSTR
    uint dwFlags   // SYMBOLIC_LINK_FLAGS
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateSymbolicLinkA(
    <MarshalAs(UnmanagedType.LPStr)> lpSymlinkFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpTargetFileName As String,   ' LPCSTR
    dwFlags As UInteger   ' SYMBOLIC_LINK_FLAGS
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' lpSymlinkFileName : LPCSTR
' lpTargetFileName : LPCSTR
' dwFlags : SYMBOLIC_LINK_FLAGS
Declare PtrSafe Function CreateSymbolicLinkA Lib "kernel32" ( _
    ByVal lpSymlinkFileName As String, _
    ByVal lpTargetFileName As String, _
    ByVal dwFlags As Long) As Byte
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateSymbolicLinkA = kernel32.NewProc("CreateSymbolicLinkA")
)

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

extern "kernel32" fn CreateSymbolicLinkA(
    lpSymlinkFileName: [*c]const u8, // LPCSTR
    lpTargetFileName: [*c]const u8, // LPCSTR
    dwFlags: u32 // SYMBOLIC_LINK_FLAGS
) callconv(std.os.windows.WINAPI) u8;
proc CreateSymbolicLinkA(
    lpSymlinkFileName: cstring,  # LPCSTR
    lpTargetFileName: cstring,  # LPCSTR
    dwFlags: uint32  # SYMBOLIC_LINK_FLAGS
): uint8 {.importc: "CreateSymbolicLinkA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
ubyte CreateSymbolicLinkA(
    const(char)* lpSymlinkFileName,   // LPCSTR
    const(char)* lpTargetFileName,   // LPCSTR
    uint dwFlags   // SYMBOLIC_LINK_FLAGS
);
ccall((:CreateSymbolicLinkA, "KERNEL32.dll"), stdcall, UInt8,
      (Cstring, Cstring, UInt32),
      lpSymlinkFileName, lpTargetFileName, dwFlags)
# lpSymlinkFileName : LPCSTR -> Cstring
# lpTargetFileName : LPCSTR -> Cstring
# dwFlags : SYMBOLIC_LINK_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint8_t CreateSymbolicLinkA(
    const char* lpSymlinkFileName,
    const char* lpTargetFileName,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateSymbolicLinkA(lpSymlinkFileName, lpTargetFileName, dwFlags)
-- lpSymlinkFileName : LPCSTR
-- lpTargetFileName : LPCSTR
-- dwFlags : SYMBOLIC_LINK_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateSymbolicLinkA = lib.func('__stdcall', 'CreateSymbolicLinkA', 'uint8_t', ['str', 'str', 'uint32_t']);
// CreateSymbolicLinkA(lpSymlinkFileName, lpTargetFileName, dwFlags)
// lpSymlinkFileName : LPCSTR -> 'str'
// lpTargetFileName : LPCSTR -> 'str'
// dwFlags : SYMBOLIC_LINK_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateSymbolicLinkA: { parameters: ["buffer", "buffer", "u32"], result: "u8" },
});
// lib.symbols.CreateSymbolicLinkA(lpSymlinkFileName, lpTargetFileName, dwFlags)
// lpSymlinkFileName : LPCSTR -> "buffer"
// lpTargetFileName : LPCSTR -> "buffer"
// dwFlags : SYMBOLIC_LINK_FLAGS -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t CreateSymbolicLinkA(
    const char* lpSymlinkFileName,
    const char* lpTargetFileName,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->CreateSymbolicLinkA(lpSymlinkFileName, lpTargetFileName, dwFlags);
// lpSymlinkFileName : LPCSTR
// lpTargetFileName : LPCSTR
// dwFlags : SYMBOLIC_LINK_FLAGS
// 構造体/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 CreateSymbolicLinkA(
        String lpSymlinkFileName,   // LPCSTR
        String lpTargetFileName,   // LPCSTR
        int dwFlags   // SYMBOLIC_LINK_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateSymbolicLinkA = CreateSymbolicLinkA(
    lpSymlinkFileName : UInt8*,   # LPCSTR
    lpTargetFileName : UInt8*,   # LPCSTR
    dwFlags : UInt32   # SYMBOLIC_LINK_FLAGS
  ) : UInt8
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateSymbolicLinkANative = Uint8 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef CreateSymbolicLinkADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int);
final CreateSymbolicLinkA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateSymbolicLinkANative, CreateSymbolicLinkADart>('CreateSymbolicLinkA');
// lpSymlinkFileName : LPCSTR -> Pointer<Utf8>
// lpTargetFileName : LPCSTR -> Pointer<Utf8>
// dwFlags : SYMBOLIC_LINK_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateSymbolicLinkA(
  lpSymlinkFileName: PAnsiChar;   // LPCSTR
  lpTargetFileName: PAnsiChar;   // LPCSTR
  dwFlags: DWORD   // SYMBOLIC_LINK_FLAGS
): ByteBool; stdcall;
  external 'KERNEL32.dll' name 'CreateSymbolicLinkA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("CreateSymbolicLinkA" create-symbolic-link-a :convention :stdcall) :uint8
  (lp-symlink-file-name :string)   ; LPCSTR
  (lp-target-file-name :string)   ; LPCSTR
  (dw-flags :uint32))   ; SYMBOLIC_LINK_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateSymbolicLinkA = Win32::API::More->new('KERNEL32',
    'BYTE CreateSymbolicLinkA(LPCSTR lpSymlinkFileName, LPCSTR lpTargetFileName, DWORD dwFlags)');
# my $ret = $CreateSymbolicLinkA->Call($lpSymlinkFileName, $lpTargetFileName, $dwFlags);
# lpSymlinkFileName : LPCSTR -> LPCSTR
# lpTargetFileName : LPCSTR -> LPCSTR
# dwFlags : SYMBOLIC_LINK_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型