CreateSymbolicLinkW 関数 (winbase.h)

  • [アーティクル]

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

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

構文

BOOLEAN CreateSymbolicLinkW(
  [in] LPCWSTR lpSymlinkFileName,
  [in] LPCWSTR 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
 プロセスが昇格されていない場合にシンボリック リンクを作成できるようにするには、このフラグを指定します。 このオプションが機能する前に、まずマシンで開発者モードを有効にする必要があります。

戻り値

関数が成功すると、戻り値は 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) はい
SMB 3.0 とスケールアウト ファイル共有 (SO) いいえ
クラスター共有ボリューム ファイル システム (CsvFS) いいえ
Resilient File System (ReFS) はい
 

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

注意

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

要件

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

関連項目

CreateSymbolicLinkTransacted

ファイル管理機能

シンボリック リンク