ホーム › Storage.FileSystem › CreateHardLinkTransactedA

CreateHardLinkTransactedA

関数

トランザクション内でハードリンクを作成する(ANSI版)。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL CreateHardLinkTransactedA(
    LPCSTR lpFileName,
    LPCSTR lpExistingFileName,
    SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    HANDLE hTransaction
);

パラメーター

名前	型	方向	説明
lpFileName	LPCSTR	in	新しいファイルの名前。このパラメーターにディレクトリの名前を指定することはできません。
lpExistingFileName	LPCSTR	in	既存のファイルの名前。このパラメーターにディレクトリの名前を指定することはできません。
lpSecurityAttributes	SECURITY_ATTRIBUTES*	optional	予約済み。NULL を指定する必要があります。
hTransaction	HANDLE	in	トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

既存のファイルと新しいファイルとの間にハードリンクを、トランザクション操作として作成します。(ANSI)

戻り値

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

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

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

ファイルはローカルコンピューター上に存在する必要があります。そうでない場合は、関数が失敗し、最後のエラーコードに ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE が設定されます。

解説(Remarks)

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

ハードリンクはファイルのディレクトリエントリにすぎないため、アプリケーションがいずれかのハードリンクを通じてファイルを変更すると、そのファイルへの他のハードリンクを使用するすべてのアプリケーションにその変更が反映されます。また、ファイルが変更されると、すべてのディレクトリエントリが更新されます。たとえば、ファイルサイズが変更された場合、そのファイルへのすべてのハードリンクには新しいファイルサイズが表示されます。

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

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

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

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

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 は TxF をサポートしていないことに注意してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 CreateHardLinkTransactedA(
    LPCSTR lpFileName,
    LPCSTR lpExistingFileName,
    SECURITY_ATTRIBUTES* lpSecurityAttributes,   // optional
    HANDLE hTransaction
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool CreateHardLinkTransactedA(
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName,   // LPCSTR
    IntPtr lpSecurityAttributes,   // SECURITY_ATTRIBUTES* optional
    IntPtr hTransaction   // HANDLE
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateHardLinkTransactedA(
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpExistingFileName As String,   ' LPCSTR
    lpSecurityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    hTransaction As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpFileName : LPCSTR
' lpExistingFileName : LPCSTR
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
' hTransaction : HANDLE
Declare PtrSafe Function CreateHardLinkTransactedA Lib "kernel32" ( _
    ByVal lpFileName As String, _
    ByVal lpExistingFileName As String, _
    ByVal lpSecurityAttributes As LongPtr, _
    ByVal hTransaction As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateHardLinkTransactedA = ctypes.windll.kernel32.CreateHardLinkTransactedA
CreateHardLinkTransactedA.restype = wintypes.BOOL
CreateHardLinkTransactedA.argtypes = [
    wintypes.LPCSTR,  # lpFileName : LPCSTR
    wintypes.LPCSTR,  # lpExistingFileName : LPCSTR
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    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')
CreateHardLinkTransactedA = Fiddle::Function.new(
  lib['CreateHardLinkTransactedA'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpExistingFileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn CreateHardLinkTransactedA(
        lpFileName: *const u8,  // LPCSTR
        lpExistingFileName: *const u8,  // LPCSTR
        lpSecurityAttributes: *mut SECURITY_ATTRIBUTES,  // SECURITY_ATTRIBUTES* optional
        hTransaction: *mut core::ffi::c_void  // HANDLE
    ) -> 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 CreateHardLinkTransactedA([MarshalAs(UnmanagedType.LPStr)] string lpFileName, [MarshalAs(UnmanagedType.LPStr)] string lpExistingFileName, IntPtr lpSecurityAttributes, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateHardLinkTransactedA' -Namespace Win32 -PassThru
# $api::CreateHardLinkTransactedA(lpFileName, lpExistingFileName, lpSecurityAttributes, hTransaction)

#uselib "KERNEL32.dll"
#func global CreateHardLinkTransactedA "CreateHardLinkTransactedA" sptr, sptr, sptr, sptr
; CreateHardLinkTransactedA lpFileName, lpExistingFileName, varptr(lpSecurityAttributes), hTransaction   ; 戻り値は stat
; lpFileName : LPCSTR -> "sptr"
; lpExistingFileName : LPCSTR -> "sptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global CreateHardLinkTransactedA "CreateHardLinkTransactedA" str, str, var, sptr
; res = CreateHardLinkTransactedA(lpFileName, lpExistingFileName, lpSecurityAttributes, hTransaction)
; lpFileName : LPCSTR -> "str"
; lpExistingFileName : LPCSTR -> "str"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; hTransaction : HANDLE -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global CreateHardLinkTransactedA "CreateHardLinkTransactedA" str, str, sptr, sptr
; res = CreateHardLinkTransactedA(lpFileName, lpExistingFileName, varptr(lpSecurityAttributes), hTransaction)
; lpFileName : LPCSTR -> "str"
; lpExistingFileName : LPCSTR -> "str"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。