ホーム › UI.Shell › PathCchCanonicalize

PathCchCanonicalize

関数

パス内の相対要素を解決して正規形に変換する。

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 PathCchCanonicalize(
    LPWSTR pszPathOut,
    UINT_PTR cchPathOut,
    LPCWSTR pszPathIn
);

パラメーター

名前	型	方向	説明
pszPathOut	LPWSTR	out	この関数が正常に終了したときに、正規化されたパス文字列を受け取るバッファーへのポインター。
cchPathOut	UINT_PTR	in	pszPathOut が指すバッファーのサイズ(文字数)。
pszPathIn	LPCWSTR	in	元のパス文字列へのポインター。この値が空の文字列を指している場合、または "." 要素と ".." 要素を削除した結果が空の文字列になる場合は、pszPathOut が指すバッファーに 1 つのバックスラッシュがコピーされます。

戻り値の型: HRESULT

公式ドキュメント

パス文字列を正規化された形式に変換します。この関数は、最終的なパスの長さが MAX_PATH に制限される点で PathCchCanonicalizeEx と異なります。この関数は、呼び出し元が返される文字列のサイズを宣言し、その文字列がスタックに格納される点で PathAllocCanonicalize と異なります。この関数は、"\"、"\?"、"\?\UNC" のプレフィックスを持つパスを受け付ける点で PathCanonicalize と異なります。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は、次のものを含む HRESULT コードを返します。

戻り値	説明
E_INVALIDARG	cchPathOut の値が PATHCCH_MAX_CCH より大きいです。
PATHCCH_E_FILENAME_TOO_LONG	パスセグメントが、標準のパスセグメント長の上限である 256 文字を超えています。
E_OUTOFMEMORY	必要なサイズのバッファーを割り当てられませんでした。

解説(Remarks)

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

パスの末尾のピリオドはすべて削除されます。ただし、"" ワイルドカード文字の直後にある場合を除きます。その場合、'' 文字の後に 1 つのピリオドが残され、それ以外の末尾のピリオドはすべて削除されます。

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

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

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

元の文字列	正規化された文字列
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 PathCchCanonicalize(
    LPWSTR pszPathOut,
    UINT_PTR cchPathOut,
    LPCWSTR pszPathIn
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "api-ms-win-core-path-l1-1-0")]
extern "system" {
    fn PathCchCanonicalize(
        pszPathOut: *mut u16,  // LPWSTR out
        cchPathOut: usize,  // UINT_PTR
        pszPathIn: *const u16  // LPCWSTR
    ) -> 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 PathCchCanonicalize([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPathOut, UIntPtr cchPathOut, [MarshalAs(UnmanagedType.LPWStr)] string pszPathIn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-path-l1-1-0_PathCchCanonicalize' -Namespace Win32 -PassThru
# $api::PathCchCanonicalize(pszPathOut, cchPathOut, pszPathIn)

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

出力引数:

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