ホーム › UI.Shell › PathAllocCanonicalize

PathAllocCanonicalize

関数

パスを正規化し結果バッファを自動確保する。

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 PathAllocCanonicalize(
    LPCWSTR pszPathIn,
    PATHCCH_OPTIONS dwFlags,
    LPWSTR* ppszPathOut
);

パラメーター

名前

型

方向

説明

pszPathIn

LPCWSTR

元の文字列を格納するバッファーへのポインター。この値を NULL にすることはできません。

dwFlags

PATHCCH_OPTIONS

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

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

ppszPathOut

LPWSTR*

out

この関数が正常に終了したときに、正規化されたパス文字列を受け取るバッファーへのポインターのアドレス。このリソースが不要になったら、LocalFree 関数を呼び出して解放するのは呼び出し元の責任です。この値を NULL にすることはできません。

戻り値の型: HRESULT

公式ドキュメント

パス文字列を正規化された形式に変換します。この関数は、結果をヒープ上に返すという点で PathCchCanonicalize および PathCchCanonicalizeEx とは異なります。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数は次の代替パス形式をサポートします。

\\?\
\\?\\UNC\
\\?\Volume{guid}\

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PathAllocCanonicalize(
    LPCWSTR pszPathIn,
    PATHCCH_OPTIONS dwFlags,
    LPWSTR* ppszPathOut
);

[DllImport("api-ms-win-core-path-l1-1-0.dll", ExactSpelling = true)]
static extern int PathAllocCanonicalize(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPathIn,   // LPCWSTR
    uint dwFlags,   // PATHCCH_OPTIONS
    IntPtr ppszPathOut   // LPWSTR* out
);

<DllImport("api-ms-win-core-path-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function PathAllocCanonicalize(
    <MarshalAs(UnmanagedType.LPWStr)> pszPathIn As String,   ' LPCWSTR
    dwFlags As UInteger,   ' PATHCCH_OPTIONS
    ppszPathOut As IntPtr   ' LPWSTR* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

PathAllocCanonicalize = ctypes.windll.LoadLibrary("api-ms-win-core-path-l1-1-0.dll").PathAllocCanonicalize
PathAllocCanonicalize.restype = ctypes.c_int
PathAllocCanonicalize.argtypes = [
    wintypes.LPCWSTR,  # pszPathIn : LPCWSTR
    wintypes.DWORD,  # dwFlags : PATHCCH_OPTIONS
    ctypes.c_void_p,  # ppszPathOut : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "api-ms-win-core-path-l1-1-0")]
extern "system" {
    fn PathAllocCanonicalize(
        pszPathIn: *const u16,  // LPCWSTR
        dwFlags: u32,  // PATHCCH_OPTIONS
        ppszPathOut: *mut *mut u16  // LPWSTR* out
    ) -> 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 PathAllocCanonicalize([MarshalAs(UnmanagedType.LPWStr)] string pszPathIn, uint dwFlags, IntPtr ppszPathOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-path-l1-1-0_PathAllocCanonicalize' -Namespace Win32 -PassThru
# $api::PathAllocCanonicalize(pszPathIn, dwFlags, ppszPathOut)

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

出力引数:

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