ホーム › UI.Shell › PathCchCanonicalizeEx

PathCchCanonicalizeEx

関数

オプション指定でパスを正規化し冗長な要素を解決する。

DLLapi-ms-win-core-path-l1-1-0.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// api-ms-win-core-path-l1-1-0.dll
#include <windows.h>

HRESULT PathCchCanonicalizeEx(
    LPWSTR pszPathOut,
    UINT_PTR cchPathOut,
    LPCWSTR pszPathIn,
    PATHCCH_OPTIONS dwFlags
);

パラメーター

名前

型

方向

説明

pszPathOut

LPWSTR

out

この関数が正常に終了したときに、編集後のパス文字列を受け取るバッファーへのポインター。

cchPathOut

UINT_PTR

pszPathOut が指すバッファーのサイズ(文字数単位)。

pszPathIn

LPCWSTR

元のパス文字列へのポインター。この値が NULL の場合、空の文字列を指している場合、または "." や ".." の要素を取り除いた結果が空の文字列になる場合は、pszPathOut が指すバッファーに単一のバックスラッシュがコピーされます。

dwFlags

PATHCCH_OPTIONS

次のフラグのうち 1 つ以上を指定します。

Value	Meaning
PATHCCH_NONE 0x0000000	MAX_PATH を超える長さの \\?\ パス(つまりロングパス)の構築を許可しません。
PATHCCH_ALLOW_LONG_PATHS 0x00000001	MAX_PATH を超える長さの \\?\ パスの構築を許可します。cchPathOut は MAX_PATH より大きくなければならない点に注意してください。そうでない場合、このフラグは無視されます。
PATHCCH_FORCE_ENABLE_LONG_NAME_PROCESS 0x00000002	プロセスのロングネーム有効状態に関わらず、呼び出し元をロングパス有効として扱うように API を強制します。このオプションは PATHCCH_ALLOW_LONG_PATHS が指定されている場合にのみ使用でき、PATHCCH_FORCE_DISABLE_LONG_NAME_PROCESS と併用することはできません。 Note この値は Windows 10 バージョン 1703 以降で使用可能です。
PATHCCH_FORCE_DISABLE_LONG_NAME_PROCESS 0x00000004	プロセスのロングネーム有効状態に関わらず、呼び出し元をロングパス無効として扱うように API を強制します。このオプションは PATHCCH_ALLOW_LONG_PATHS が指定されている場合にのみ使用でき、PATHCCH_FORCE_ENABLE_LONG_NAME_PROCESS と併用することはできません。 Note この値は Windows 10 バージョン 1703 以降で使用可能です。
PATHCCH_DO_NOT_NORMALIZE_SEGMENTS 0x00000008	末尾のドットやスペースの除去を含むパスセグメントの正規化を無効にします。これにより、Win32 のパス正規化ではブロックされるパスへのアクセスが可能になります。 Note この値は Windows 10 バージョン 1703 以降で使用可能です。
PATHCCH_ENSURE_IS_EXTENDED_LENGTH_PATH 0x00000010	入力パスがまだその形式でない場合、拡張長 DOS デバイスパス形式(\\?\ プレフィックス付き)に変換します。これにより、Win32 の正規化規則(末尾のドットやスペースを除去する可能性があります)やパス長の制限のために通常はアドレス指定できないパスへのアクセスが可能になります。このオプションは PATHCCH_DO_NOT_NORMALIZE_SEGMENTS と同じ動作を含みます。 Note この値は Windows 10 バージョン 1703 以降で使用可能です。
PATHCCH_ENSURE_TRAILING_SLASH 0x00000020	パスを結合または正規化する際に、末尾にバックスラッシュがあることを保証します。 Note この値は Windows 10 バージョン 1703 以降で使用可能です。

戻り値の型: HRESULT

公式ドキュメント

"." や ".." などのナビゲーション要素を取り除いてパスを単純化し、直接的で正しい形式のパスを生成します。この関数は、より長い最終パスを構築できる点で PathCchCanonicalize と異なります。この関数は、返される文字列のサイズを呼び出し元が宣言し、その文字列がスタックに格納される点で PathAllocCanonicalize と異なります。この関数は、"\"、"\?"、"\?\UNC" プレフィックスを持つパスを受け付ける点で PathCanonicalize と異なります。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は、以下を含む(ただしこれらに限定されない) HRESULT コードを返します。

Return code	Description
E_INVALIDARG	cchPathOut の値が PATHCCH_MAX_CCH より大きいです。
PATHCCH_E_FILENAME_TOO_LONG	パスセグメントが PATHCCH_MAX_CCH 文字を超えているか、または PATHCCH_ALLOW_LONG_PATHS フラグが設定されていない場合に、標準のパスセグメント長制限である 256 文字を超えています。
E_OUTOFMEMORY	必要なサイズのバッファーを割り当てることができませんでした。

解説(Remarks)

この関数は、パスに埋め込まれた "." および ".." の文字列に反応します。".." 文字列は、直前のパスセグメントを削除することを示します。"." 文字列は、次のパスセグメントをスキップすることを示します。パスのルートセグメントは削除できない点に注意してください。パスセグメントの数よりも多くの ".." 文字列がある場合、この関数は S_OK を返し、pszPathOut が指すバッファーには単一のバックスラッシュ "\" が格納されます。

パスから末尾のピリオドはすべて削除されますが、"" ワイルドカード文字が直前にある場合は除きます。その場合、'' 文字の後に単一のピリオドが残され、それ以外の末尾のピリオドはすべて削除されます。

結果として得られるパスがルートドライブ("x:")の場合、バックスラッシュが追加されます("x:\")。

この関数はスラッシュ(/)をバックスラッシュ(\)に変換しません。信頼できない入力に対して、この関数単独では、サブパスや同一性を他のパスと比較できる形式にパスを変換することはできません。その機能を必要とする呼び出し元は、この関数を使用する前にスラッシュをバックスラッシュに変換してください。

次の例は、これらの文字列の効果を示しています。

Original string	Canonicalized string
C:\name_1\.\name_2\..\name_3	C:\name_1\name_3
C:\name_1\..\name_2\.\name_3	C:\name_2\name_3
C:\name_1\name_2\.\name_3\..\name_4	C:\name_1\name_2\name_4
C:\name_1\.\name_2\.\name_3\..\name_4\..	C:\name_1\name_2
C:\name_1\*...	C:\name_1\*.
C:\..	C:\

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// api-ms-win-core-path-l1-1-0.dll
#include <windows.h>

HRESULT PathCchCanonicalizeEx(
    LPWSTR pszPathOut,
    UINT_PTR cchPathOut,
    LPCWSTR pszPathIn,
    PATHCCH_OPTIONS dwFlags
);

[DllImport("api-ms-win-core-path-l1-1-0.dll", ExactSpelling = true)]
static extern int PathCchCanonicalizeEx(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPathOut,   // LPWSTR out
    UIntPtr cchPathOut,   // UINT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string pszPathIn,   // LPCWSTR
    uint dwFlags   // PATHCCH_OPTIONS
);

<DllImport("api-ms-win-core-path-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function PathCchCanonicalizeEx(
    <MarshalAs(UnmanagedType.LPWStr)> pszPathOut As System.Text.StringBuilder,   ' LPWSTR out
    cchPathOut As UIntPtr,   ' UINT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> pszPathIn As String,   ' LPCWSTR
    dwFlags As UInteger   ' PATHCCH_OPTIONS
) As Integer
End Function

' pszPathOut : LPWSTR out
' cchPathOut : UINT_PTR
' pszPathIn : LPCWSTR
' dwFlags : PATHCCH_OPTIONS
Declare PtrSafe Function PathCchCanonicalizeEx Lib "api-ms-win-core-path-l1-1-0" ( _
    ByVal pszPathOut As LongPtr, _
    ByVal cchPathOut As LongPtr, _
    ByVal pszPathIn As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathCchCanonicalizeEx = ctypes.windll.LoadLibrary("api-ms-win-core-path-l1-1-0.dll").PathCchCanonicalizeEx
PathCchCanonicalizeEx.restype = ctypes.c_int
PathCchCanonicalizeEx.argtypes = [
    wintypes.LPWSTR,  # pszPathOut : LPWSTR out
    ctypes.c_size_t,  # cchPathOut : UINT_PTR
    wintypes.LPCWSTR,  # pszPathIn : LPCWSTR
    wintypes.DWORD,  # dwFlags : PATHCCH_OPTIONS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-path-l1-1-0.dll')
PathCchCanonicalizeEx = Fiddle::Function.new(
  lib['PathCchCanonicalizeEx'],
  [
    Fiddle::TYPE_VOIDP,  # pszPathOut : LPWSTR out
    Fiddle::TYPE_UINTPTR_T,  # cchPathOut : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pszPathIn : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : PATHCCH_OPTIONS
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-core-path-l1-1-0")]
extern "system" {
    fn PathCchCanonicalizeEx(
        pszPathOut: *mut u16,  // LPWSTR out
        cchPathOut: usize,  // UINT_PTR
        pszPathIn: *const u16,  // LPCWSTR
        dwFlags: u32  // PATHCCH_OPTIONS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("api-ms-win-core-path-l1-1-0.dll")]
public static extern int PathCchCanonicalizeEx([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPathOut, UIntPtr cchPathOut, [MarshalAs(UnmanagedType.LPWStr)] string pszPathIn, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-path-l1-1-0_PathCchCanonicalizeEx' -Namespace Win32 -PassThru
# $api::PathCchCanonicalizeEx(pszPathOut, cchPathOut, pszPathIn, dwFlags)

#uselib "api-ms-win-core-path-l1-1-0.dll"
#func global PathCchCanonicalizeEx "PathCchCanonicalizeEx" sptr, sptr, sptr, sptr
; PathCchCanonicalizeEx varptr(pszPathOut), cchPathOut, pszPathIn, dwFlags   ; 戻り値は stat
; pszPathOut : LPWSTR out -> "sptr"
; cchPathOut : UINT_PTR -> "sptr"
; pszPathIn : LPCWSTR -> "sptr"
; dwFlags : PATHCCH_OPTIONS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-core-path-l1-1-0.dll"
#cfunc global PathCchCanonicalizeEx "PathCchCanonicalizeEx" var, sptr, wstr, int
; res = PathCchCanonicalizeEx(pszPathOut, cchPathOut, pszPathIn, dwFlags)
; pszPathOut : LPWSTR out -> "var"
; cchPathOut : UINT_PTR -> "sptr"
; pszPathIn : LPCWSTR -> "wstr"
; dwFlags : PATHCCH_OPTIONS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-core-path-l1-1-0.dll"
#cfunc global PathCchCanonicalizeEx "PathCchCanonicalizeEx" sptr, sptr, wstr, int
; res = PathCchCanonicalizeEx(varptr(pszPathOut), cchPathOut, pszPathIn, dwFlags)
; pszPathOut : LPWSTR out -> "sptr"
; cchPathOut : UINT_PTR -> "sptr"
; pszPathIn : LPCWSTR -> "wstr"
; dwFlags : PATHCCH_OPTIONS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。