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

CreateSymbolicLinkW

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

シグネチャ

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

BOOLEAN CreateSymbolicLinkW(
    LPCWSTR lpSymlinkFileName,
    LPCWSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags
);

パラメーター

名前方向説明
lpSymlinkFileNameLPCWSTRin

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

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

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

ヒント

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

lpTargetFileNameLPCWSTRin

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

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

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

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

ヒント

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

dwFlagsSYMBOLIC_LINK_FLAGSin

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

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

戻り値の型: BOOLEAN

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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) はい

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateSymbolicLinkW(
    LPCWSTR lpSymlinkFileName,
    LPCWSTR lpTargetFileName,
    SYMBOLIC_LINK_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.U1)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CreateSymbolicLinkW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpSymlinkFileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpTargetFileName,   // LPCWSTR
    uint dwFlags   // SYMBOLIC_LINK_FLAGS
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateSymbolicLinkW(
    <MarshalAs(UnmanagedType.LPWStr)> lpSymlinkFileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpTargetFileName As String,   ' LPCWSTR
    dwFlags As UInteger   ' SYMBOLIC_LINK_FLAGS
) As <MarshalAs(UnmanagedType.U1)> Boolean
End Function
' lpSymlinkFileName : LPCWSTR
' lpTargetFileName : LPCWSTR
' dwFlags : SYMBOLIC_LINK_FLAGS
Declare PtrSafe Function CreateSymbolicLinkW Lib "kernel32" ( _
    ByVal lpSymlinkFileName As LongPtr, _
    ByVal lpTargetFileName As LongPtr, _
    ByVal dwFlags As Long) 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

CreateSymbolicLinkW = ctypes.windll.kernel32.CreateSymbolicLinkW
CreateSymbolicLinkW.restype = wintypes.BOOLEAN
CreateSymbolicLinkW.argtypes = [
    wintypes.LPCWSTR,  # lpSymlinkFileName : LPCWSTR
    wintypes.LPCWSTR,  # lpTargetFileName : LPCWSTR
    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')
CreateSymbolicLinkW = Fiddle::Function.new(
  lib['CreateSymbolicLinkW'],
  [
    Fiddle::TYPE_VOIDP,  # lpSymlinkFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpTargetFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : SYMBOLIC_LINK_FLAGS
  ],
  Fiddle::TYPE_CHAR)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn CreateSymbolicLinkW(
        lpSymlinkFileName: *const u16,  // LPCWSTR
        lpTargetFileName: *const u16,  // LPCWSTR
        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.Unicode, SetLastError = true)]
public static extern bool CreateSymbolicLinkW([MarshalAs(UnmanagedType.LPWStr)] string lpSymlinkFileName, [MarshalAs(UnmanagedType.LPWStr)] string lpTargetFileName, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateSymbolicLinkW' -Namespace Win32 -PassThru
# $api::CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags)
#uselib "KERNEL32.dll"
#func global CreateSymbolicLinkW "CreateSymbolicLinkW" wptr, wptr, wptr
; CreateSymbolicLinkW lpSymlinkFileName, lpTargetFileName, dwFlags   ; 戻り値は stat
; lpSymlinkFileName : LPCWSTR -> "wptr"
; lpTargetFileName : LPCWSTR -> "wptr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateSymbolicLinkW "CreateSymbolicLinkW" wstr, wstr, int
; res = CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags)
; lpSymlinkFileName : LPCWSTR -> "wstr"
; lpTargetFileName : LPCWSTR -> "wstr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "int"
; BOOLEAN CreateSymbolicLinkW(LPCWSTR lpSymlinkFileName, LPCWSTR lpTargetFileName, SYMBOLIC_LINK_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global CreateSymbolicLinkW "CreateSymbolicLinkW" wstr, wstr, int
; res = CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags)
; lpSymlinkFileName : LPCWSTR -> "wstr"
; lpTargetFileName : LPCWSTR -> "wstr"
; dwFlags : SYMBOLIC_LINK_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateSymbolicLinkW = kernel32.NewProc("CreateSymbolicLinkW")
)

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

extern "kernel32" fn CreateSymbolicLinkW(
    lpSymlinkFileName: [*c]const u16, // LPCWSTR
    lpTargetFileName: [*c]const u16, // LPCWSTR
    dwFlags: u32 // SYMBOLIC_LINK_FLAGS
) callconv(std.os.windows.WINAPI) u8;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CreateSymbolicLinkW(
    lpSymlinkFileName: WideCString,  # LPCWSTR
    lpTargetFileName: WideCString,  # LPCWSTR
    dwFlags: uint32  # SYMBOLIC_LINK_FLAGS
): uint8 {.importc: "CreateSymbolicLinkW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
ubyte CreateSymbolicLinkW(
    const(wchar)* lpSymlinkFileName,   // LPCWSTR
    const(wchar)* lpTargetFileName,   // LPCWSTR
    uint dwFlags   // SYMBOLIC_LINK_FLAGS
);
ccall((:CreateSymbolicLinkW, "KERNEL32.dll"), stdcall, UInt8,
      (Cwstring, Cwstring, UInt32),
      lpSymlinkFileName, lpTargetFileName, dwFlags)
# lpSymlinkFileName : LPCWSTR -> Cwstring
# lpTargetFileName : LPCWSTR -> Cwstring
# dwFlags : SYMBOLIC_LINK_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint8_t CreateSymbolicLinkW(
    const uint16_t* lpSymlinkFileName,
    const uint16_t* lpTargetFileName,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags)
-- lpSymlinkFileName : LPCWSTR
-- lpTargetFileName : LPCWSTR
-- dwFlags : SYMBOLIC_LINK_FLAGS
-- 構造体/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 CreateSymbolicLinkW = lib.func('__stdcall', 'CreateSymbolicLinkW', 'uint8_t', ['str16', 'str16', 'uint32_t']);
// CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags)
// lpSymlinkFileName : LPCWSTR -> 'str16'
// lpTargetFileName : LPCWSTR -> 'str16'
// dwFlags : SYMBOLIC_LINK_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateSymbolicLinkW: { parameters: ["buffer", "buffer", "u32"], result: "u8" },
});
// lib.symbols.CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags)
// lpSymlinkFileName : LPCWSTR -> "buffer"
// lpTargetFileName : LPCWSTR -> "buffer"
// dwFlags : SYMBOLIC_LINK_FLAGS -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint8_t CreateSymbolicLinkW(
    const uint16_t* lpSymlinkFileName,
    const uint16_t* lpTargetFileName,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->CreateSymbolicLinkW(lpSymlinkFileName, lpTargetFileName, dwFlags);
// lpSymlinkFileName : LPCWSTR
// lpTargetFileName : LPCWSTR
// 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.UNICODE_OPTIONS);
    byte CreateSymbolicLinkW(
        WString lpSymlinkFileName,   // LPCWSTR
        WString lpTargetFileName,   // LPCWSTR
        int dwFlags   // SYMBOLIC_LINK_FLAGS
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateSymbolicLinkW = CreateSymbolicLinkW(
    lpSymlinkFileName : UInt16*,   # LPCWSTR
    lpTargetFileName : UInt16*,   # LPCWSTR
    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 CreateSymbolicLinkWNative = Uint8 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef CreateSymbolicLinkWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final CreateSymbolicLinkW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateSymbolicLinkWNative, CreateSymbolicLinkWDart>('CreateSymbolicLinkW');
// lpSymlinkFileName : LPCWSTR -> Pointer<Utf16>
// lpTargetFileName : LPCWSTR -> Pointer<Utf16>
// dwFlags : SYMBOLIC_LINK_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateSymbolicLinkW(
  lpSymlinkFileName: PWideChar;   // LPCWSTR
  lpTargetFileName: PWideChar;   // LPCWSTR
  dwFlags: DWORD   // SYMBOLIC_LINK_FLAGS
): ByteBool; stdcall;
  external 'KERNEL32.dll' name 'CreateSymbolicLinkW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let createsymboliclinkw =
  foreign "CreateSymbolicLinkW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint8_t)
(* lpSymlinkFileName : LPCWSTR -> (ptr uint16_t) *)
(* lpTargetFileName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("CreateSymbolicLinkW" create-symbolic-link-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
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateSymbolicLinkW = Win32::API::More->new('KERNEL32',
    'BYTE CreateSymbolicLinkW(LPCWSTR lpSymlinkFileName, LPCWSTR lpTargetFileName, DWORD dwFlags)');
# my $ret = $CreateSymbolicLinkW->Call($lpSymlinkFileName, $lpTargetFileName, $dwFlags);
# lpSymlinkFileName : LPCWSTR -> LPCWSTR
# lpTargetFileName : LPCWSTR -> LPCWSTR
# dwFlags : SYMBOLIC_LINK_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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