Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
pszPathOutLPWSTRout
cchPathOutUINT_PTRin
pszPathInLPCWSTRin
dwFlagsPATHCCH_OPTIONSin

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HRESULT PathCchCanonicalizeEx(LPWSTR pszPathOut, UINT_PTR cchPathOut, LPCWSTR pszPathIn, PATHCCH_OPTIONS dwFlags)
#uselib "api-ms-win-core-path-l1-1-0.dll"
#cfunc global PathCchCanonicalizeEx "PathCchCanonicalizeEx" var, intptr, wstr, int
; res = PathCchCanonicalizeEx(pszPathOut, cchPathOut, pszPathIn, dwFlags)
; pszPathOut : LPWSTR out -> "var"
; cchPathOut : UINT_PTR -> "intptr"
; pszPathIn : LPCWSTR -> "wstr"
; dwFlags : PATHCCH_OPTIONS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_path_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-core-path-l1-1-0.dll")
	procPathCchCanonicalizeEx = api_ms_win_core_path_l1_1_0.NewProc("PathCchCanonicalizeEx")
)

// pszPathOut (LPWSTR out), cchPathOut (UINT_PTR), pszPathIn (LPCWSTR), dwFlags (PATHCCH_OPTIONS)
r1, _, err := procPathCchCanonicalizeEx.Call(
	uintptr(pszPathOut),
	uintptr(cchPathOut),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszPathIn))),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PathCchCanonicalizeEx(
  pszPathOut: PWideChar;   // LPWSTR out
  cchPathOut: NativeUInt;   // UINT_PTR
  pszPathIn: PWideChar;   // LPCWSTR
  dwFlags: DWORD   // PATHCCH_OPTIONS
): Integer; stdcall;
  external 'api-ms-win-core-path-l1-1-0.dll' name 'PathCchCanonicalizeEx';
result := DllCall("api-ms-win-core-path-l1-1-0\PathCchCanonicalizeEx"
    , "Ptr", pszPathOut   ; LPWSTR out
    , "UPtr", cchPathOut   ; UINT_PTR
    , "WStr", pszPathIn   ; LPCWSTR
    , "UInt", dwFlags   ; PATHCCH_OPTIONS
    , "Int")   ; return: HRESULT
●PathCchCanonicalizeEx(pszPathOut, cchPathOut, pszPathIn, dwFlags) = DLL("api-ms-win-core-path-l1-1-0.dll", "int PathCchCanonicalizeEx(char*, int, char*, dword)")
# 呼び出し: PathCchCanonicalizeEx(pszPathOut, cchPathOut, pszPathIn, dwFlags)
# pszPathOut : LPWSTR out -> "char*"
# cchPathOut : UINT_PTR -> "int"
# pszPathIn : LPCWSTR -> "char*"
# dwFlags : PATHCCH_OPTIONS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。