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

CreateHardLinkA

関数
既存ファイルへのハードリンクを作成する(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CreateHardLinkA(
    LPCSTR lpFileName,
    LPCSTR lpExistingFileName,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

名前方向説明
lpFileNameLPCSTRin

新しいファイルの名前。

このパラメーターにはパスを含めることができますが、ディレクトリの名前を指定することはできません。

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

ヒント

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

lpExistingFileNameLPCSTRin

既存のファイルの名前。

このパラメーターにはパスを含めることができますが、ディレクトリの名前を指定することはできません。

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

ヒント

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

lpSecurityAttributesSECURITY_ATTRIBUTES*optional予約済み。NULL を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

既存のファイルと新しいファイルとの間にハードリンクを確立します。(ANSI)

戻り値

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

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

この関数で作成できるハードリンクの最大数は、1 ファイルあたり 1023 個です。1 つのファイルに対して 1023 個を超えるリンクを作成しようとすると、エラーが発生します。

この関数の ANSI バージョンの lpFileName または lpExistingFileName パラメーターに、あるいは Unicode バージョンにパスの先頭へ "\\?\" を付加せずに、MAX_PATH 文字より長い名前を渡した場合、関数は ERROR_PATH_NOT_FOUND を返します。

解説(Remarks)

CreateFile または CreateHardLink で作成されたファイルのディレクトリエントリは、関連付けられたファイルへのハードリンクです。 CreateHardLink 関数で作成される追加のハードリンクにより、1 つのファイルに対して複数のディレクトリエントリ、すなわち同じファイルへの複数のハードリンクを持つことができます。これらは、同じディレクトリ内で異なる名前にすることも、異なるディレクトリ内で同じ名前または異なる名前にすることもできます。ただし、ファイルへのすべてのハードリンクは同じボリューム上に存在しなければなりません。

ハードリンクはファイルのディレクトリエントリにすぎないため、そのファイルに対する多くの変更は、それを参照するハードリンクを介してファイルにアクセスするアプリケーションに即座に反映されます。ただし、ディレクトリエントリのサイズと属性情報は、変更を行ったリンクについてのみ更新されます。

セキュリティ記述子は、ハードリンクが指すファイルに属します。リンク自体は単なるディレクトリエントリであり、セキュリティ記述子を持ちません。したがって、ハードリンクのセキュリティ記述子を変更すると、基になるファイルのセキュリティ記述子が変更され、そのファイルを指すすべてのハードリンクで新しく指定されたアクセスが許可されます。ハードリンクごとに異なるセキュリティ記述子をファイルに与えることはできません。

この関数は、lpSecurityAttributes パラメーターでセキュリティ記述子情報が渡された場合でも、リンク先のファイルのセキュリティ記述子を変更しません。

ハードリンクを削除するには、DeleteFile を使用します。ハードリンクは、作成された順序に関係なく任意の順序で削除できます。

CreateFile で指定されるフラグ、属性、アクセス、共有は、ファイル単位で機能します。つまり、共有を許可しないファイルを開いた場合、別のアプリケーションはそのファイルへの新しいハードリンクを作成することによってファイルを共有することはできません。

NTFS ファイルシステム上でハードリンクを作成すると、ディレクトリエントリ内のファイル属性情報は、ファイルが開かれたとき、または特定のファイルのハンドルを指定して GetFileInformationByHandle が呼び出されたときにのみ更新されます。

シンボリックリンクの動作 — パスがシンボリックリンクを指している場合、関数はそのシンボリックリンクへのハードリンクを作成します。

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 では、継続的可用性機能を持つ共有上でのハードリンクの作成はサポートされていません。

次のコードスニペットは、ファイルのセキュリティ記述子を変更しないように CreateHardLink を呼び出す方法を示しています。pszExistingFileName パラメーターには、元のファイル名、またはファイルへの任意の既存のリンクを指定できます。このコードを実行すると、pszNewLinkName がそのファイルを参照します。

  BOOL fCreatedLink = CreateHardLink( pszNewLinkName, 
                                      pszExistingFileName, 
                                      NULL ); // reserved, must be NULL

  if ( fCreatedLink == FALSE )
   {
    ;// handle error condition
   }
メモ

winbase.h ヘッダーは CreateHardLink を、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>

BOOL CreateHardLinkA(
    LPCSTR lpFileName,
    LPCSTR lpExistingFileName,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateHardLinkA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName,   // LPCSTR
    IntPtr lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateHardLinkA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpExistingFileName As String,   ' LPCSTR
    lpSecurityAttributes As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpFileName : LPCSTR
' lpExistingFileName : LPCSTR
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function CreateHardLinkA Lib "kernel32" ( _
    ByVal lpFileName As String, _
    ByVal lpExistingFileName As String, _
    ByVal lpSecurityAttributes As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateHardLinkA = ctypes.windll.kernel32.CreateHardLinkA
CreateHardLinkA.restype = wintypes.BOOL
CreateHardLinkA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.LPCSTR,  # lpExistingFileName : LPCSTR
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateHardLinkA = Fiddle::Function.new(
  lib['CreateHardLinkA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn CreateHardLinkA(
        lpFileName: *const u8,  // LPCSTR
        lpExistingFileName: *const u8,  // LPCSTR
        lpSecurityAttributes: *mut SECURITY_ATTRIBUTES  // SECURITY_ATTRIBUTES* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool CreateHardLinkA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, [MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, IntPtr lpSecurityAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateHardLinkA' -Namespace Win32 -PassThru
# $api::CreateHardLinkA(lpFileName, lpExistingFileName, lpSecurityAttributes)
#uselib "KERNEL32.dll"
#func global CreateHardLinkA "CreateHardLinkA" sptr, sptr, sptr
; CreateHardLinkA lpFileName, lpExistingFileName, varptr(lpSecurityAttributes)   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; lpExistingFileName : LPCSTR -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global CreateHardLinkA "CreateHardLinkA" str, str, var
; res = CreateHardLinkA(lpFileName, lpExistingFileName, lpSecurityAttributes)
; lpFileName : LPCSTR -> "str"
; lpExistingFileName : LPCSTR -> "str"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL CreateHardLinkA(LPCSTR lpFileName, LPCSTR lpExistingFileName, SECURITY_ATTRIBUTES* lpSecurityAttributes)
#uselib "KERNEL32.dll"
#cfunc global CreateHardLinkA "CreateHardLinkA" str, str, var
; res = CreateHardLinkA(lpFileName, lpExistingFileName, lpSecurityAttributes)
; lpFileName : LPCSTR -> "str"
; lpExistingFileName : LPCSTR -> "str"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateHardLinkA = kernel32.NewProc("CreateHardLinkA")
)

// lpFileName (LPCSTR), lpExistingFileName (LPCSTR), lpSecurityAttributes (SECURITY_ATTRIBUTES* optional)
r1, _, err := procCreateHardLinkA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpExistingFileName))),
	uintptr(lpSecurityAttributes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CreateHardLinkA(
  lpFileName: PAnsiChar;   // LPCSTR
  lpExistingFileName: PAnsiChar;   // LPCSTR
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreateHardLinkA';
result := DllCall("KERNEL32\CreateHardLinkA"
    , "AStr", lpFileName   ; LPCSTR
    , "AStr", lpExistingFileName   ; LPCSTR
    , "Ptr", lpSecurityAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Int")   ; return: BOOL
●CreateHardLinkA(lpFileName, lpExistingFileName, lpSecurityAttributes) = DLL("KERNEL32.dll", "bool CreateHardLinkA(char*, char*, void*)")
# 呼び出し: CreateHardLinkA(lpFileName, lpExistingFileName, lpSecurityAttributes)
# lpFileName : LPCSTR -> "char*"
# lpExistingFileName : LPCSTR -> "char*"
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CreateHardLinkANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
typedef CreateHardLinkADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
final CreateHardLinkA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateHardLinkANative, CreateHardLinkADart>('CreateHardLinkA');
// lpFileName : LPCSTR -> Pointer<Utf8>
// lpExistingFileName : LPCSTR -> Pointer<Utf8>
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateHardLinkA(
  lpFileName: PAnsiChar;   // LPCSTR
  lpExistingFileName: PAnsiChar;   // LPCSTR
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'CreateHardLinkA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateHardLinkA"
  c_CreateHardLinkA :: CString -> CString -> Ptr () -> IO CInt
-- lpFileName : LPCSTR -> CString
-- lpExistingFileName : LPCSTR -> CString
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createhardlinka =
  foreign "CreateHardLinkA"
    (string @-> string @-> (ptr void) @-> returning int32_t)
(* lpFileName : LPCSTR -> string *)
(* lpExistingFileName : LPCSTR -> string *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateHardLinkA" create-hard-link-a :convention :stdcall) :int32
  (lp-file-name :string)   ; LPCSTR
  (lp-existing-file-name :string)   ; LPCSTR
  (lp-security-attributes :pointer))   ; SECURITY_ATTRIBUTES* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateHardLinkA = Win32::API::More->new('KERNEL32',
    'BOOL CreateHardLinkA(LPCSTR lpFileName, LPCSTR lpExistingFileName, LPVOID lpSecurityAttributes)');
# my $ret = $CreateHardLinkA->Call($lpFileName, $lpExistingFileName, $lpSecurityAttributes);
# lpFileName : LPCSTR -> LPCSTR
# lpExistingFileName : LPCSTR -> LPCSTR
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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