CreateSymbolicLinkA 関数 (winbase.h)

  • [アーティクル]

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

この操作をトランザクション操作として実行するには、 CreateSymbolicLinkTransacted 関数を使用します。

構文

BOOLEAN CreateSymbolicLinkA(
  [in] LPCSTR lpSymlinkFileName,
  [in] LPCSTR lpTargetFileName,
  [in] DWORD  dwFlags
);

パラメーター

[in] lpSymlinkFileName

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

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

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

ヒント

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

[in] lpTargetFileName

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

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

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

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

ヒント

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

[in] dwFlags

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

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

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

シンボリック リンクは、絶対リンクと相対リンクのどちらにすることもできます。 絶対リンクは、パス名の各部分を指定するリンクです。相対リンクは、指定されたパス内の相対リンク指定子の場所を基準にして決定されます。 相対リンクは、次の規則を使用して指定されます。

  • ドット (. および ..) の規則 - たとえば、"..\" は親ディレクトリを基準としたパスに解決されます。
  • スラッシュ (\\) のない名前 ( "tmp" など) は、現在のディレクトリに対する相対パスを解決します。
  • ルート相対 - たとえば、"\Windows\System32" は "current drive:\Windows\System32" に解決されます。
  • 現在の作業ディレクトリ - 相対 - たとえば、現在の作業ディレクトリが C:\Windows\System32 の場合、"C:File.txt" は "C:\Windows\System32\File.txt" に解決されます。
    注 現在の作業ディレクトリを基準とするリンクを指定した場合、それは絶対リンクとして作成されます。これは、現在の作業ディレクトリがユーザーとスレッドに基づいて処理されるためです。
     
シンボリック リンクを削除するには、使用されているシンボリック リンクの種類に応じて、( DeleteFile または類似の API を使用して) ファイルを削除するか、ディレクトリを削除します ( RemoveDirectory または同様の API を使用)。

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

テクノロジ サポートされています
サーバー メッセージ ブロック (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
スケールアウト ファイル共有 (SO) を使う SMB 3.0 いいえ
クラスターの共有ボリューム ファイル システム (CsvFS) いいえ
Resilient File System (ReFS) はい
 

CsvF では、ソフト リンクやその他の再解析ポイントはサポートされていません。

注意

winbase.h ヘッダーは、CreateSymbolicLink をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

CreateSymbolicLinkTransacted

File Management 関数

シンボリック リンク