PathCanonicalizeA
関数相対指定を解決しパスを正規形に整える。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathCanonicalizeA(
LPSTR pszBuf,
LPCSTR pszPath
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pszBuf | LPSTR | out | 正規化されたパスを受け取る文字列へのポインター。返される文字列を保持できる十分な大きさを確保するため、このバッファーのサイズは MAX_PATH に設定する必要があります。 |
| pszPath | LPCSTR | in | 正規化対象のパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインター。 |
戻り値の型: BOOL
公式ドキュメント
"." や ".." などのナビゲーション要素を取り除いてパスを単純化し、直接的で整形式のパスを生成します。(ANSI)
戻り値
型: BOOL
結果が計算され、lpszDst 出力バッファーの内容が有効な場合は TRUE を返します。それ以外の場合は FALSE を返し、lpszDst が指すバッファーの内容は無効です。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
この関数では、パスに特殊な文字シーケンスを挿入することで、パスから何を取り除くかを指定できます。「..」シーケンスは、現在の位置から 1 つ前のパスセグメントまでのパスセグメントを取り除くことを示します。「.」シーケンスは、次のパスセグメントをスキップしてその次のパスセグメントへ進むことを示します。パスのルートセグメントは取り除けません。
パスセグメントの数よりも「..」シーケンスの数が多い場合、この関数は TRUE を返し、lpszDst が指すバッファーの内容はルート「\」のみになります。
例
#include <windows.h>
#include <iostream>
#include "Shlwapi.h"
using namespace std;
int main( void )
{
// Path_1 destination buffer.
char buffer_1[MAX_PATH] = "JustABufferToHoldTheCanonicalizedPathForAnExample";
char *lpStr1;
lpStr1 = buffer_1;
// Path_2 to be Canonicalized.
char buffer_2[ ] = "A:\\name_1\\.\\name_2\\..\\name_3";
char *lpStr2;
lpStr2 = buffer_2;
// Path_3 to be Canonicalized.
char buffer_3[ ] = "A:\\name_1\\..\\name_2\\.\\name_3";
char *lpStr3;
lpStr3 = buffer_3;
// Path_4 to be Canonicalized.
char buffer_4[ ] = "A:\\name_1\\name_2\\.\\name_3\\..\\name_4";
char *lpStr4;
lpStr4 = buffer_4;
// Path_5 to be Canonicalized.
char buffer_5[ ] = "A:\\name_1\\.\\name_2\\.\\name_3\\..\\name_4\\..";
char *lpStr5;
lpStr5 = buffer_5;
// Path_6 to be Canonicalized.
char buffer_6[ ] = "C:\\..";
char *lpStr6;
lpStr6 = buffer_6;
cout << "The un-canonicalized path 2 is : " << lpStr2
<< "\nThe return value is : "
<< PathCanonicalize(lpStr1,lpStr2)
<< "\nThe canonicalized path 1 is : " << lpStr1 << endl;
cout << "\nThe un-canonicalized path 3 is : " << lpStr3
<< "\nThe return value is : "
<< PathCanonicalize(lpStr1,lpStr3)
<< "\nThe canonicalized path 1 is : " << lpStr1 << endl;
cout << "\nThe un-canonicalized path 4 is : " << lpStr4
<< "\nThe return value is : "
<< PathCanonicalize(lpStr1,lpStr4)
<< "\nThe canonicalized path 1 is : " << lpStr1 << endl;
cout << "\nThe un-canonicalized path 5 is : " << lpStr5
<< "\nThe return value is : "
<< PathCanonicalize(lpStr1,lpStr5)
<< "\nThe canonicalized path 1 is : " << lpStr1 << endl;
cout << "\nThe un-canonicalized path 6 is : " << lpStr6
<< "\nThe return value is : "
<< PathCanonicalize(lpStr1,lpStr6)
<< "\nThe canonicalized path 1 is : " << lpStr1 << endl;
}
OUTPUT:
---------
The un-canonicalized path 2 is : A:\name_1\.\name_2\..\name_3
The return value is : 1
The canonicalized path 1 is : A:\name_1\name_3
The un-canonicalized path 3 is : A:\name_1\..\name_2\.\name_3
The return value is : 1
The canonicalized path 1 is : A:\name_2\name_3
The un-canonicalized path 4 is : A:\name_1\name_2\.\name_3\..\name_4
The return value is : 1
The canonicalized path 1 is : A:\name_1\name_2\name_4
The un-canonicalized path 5 is : A:\name_1\.\name_2\.\name_3\..\name_4\..
The return value is : 1
The canonicalized path 1 is : A:\name_1\name_2
The un-canonicalized path 6 is : C:\..
The return value is : 1
The canonicalized path 1 is : C:\
メモ
shlwapi.h ヘッダーは PathCanonicalize を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
BOOL PathCanonicalizeA(
LPSTR pszBuf,
LPCSTR pszPath
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool PathCanonicalizeA(
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, // LPSTR out
[MarshalAs(UnmanagedType.LPStr)] string pszPath // LPCSTR
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PathCanonicalizeA(
<MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder, ' LPSTR out
<MarshalAs(UnmanagedType.LPStr)> pszPath As String ' LPCSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pszBuf : LPSTR out
' pszPath : LPCSTR
Declare PtrSafe Function PathCanonicalizeA Lib "shlwapi" ( _
ByVal pszBuf As String, _
ByVal pszPath As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PathCanonicalizeA = ctypes.windll.shlwapi.PathCanonicalizeA
PathCanonicalizeA.restype = wintypes.BOOL
PathCanonicalizeA.argtypes = [
wintypes.LPSTR, # pszBuf : LPSTR out
wintypes.LPCSTR, # pszPath : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
PathCanonicalizeA = Fiddle::Function.new(
lib['PathCanonicalizeA'],
[
Fiddle::TYPE_VOIDP, # pszBuf : LPSTR out
Fiddle::TYPE_VOIDP, # pszPath : LPCSTR
],
Fiddle::TYPE_INT)#[link(name = "shlwapi")]
extern "system" {
fn PathCanonicalizeA(
pszBuf: *mut u8, // LPSTR out
pszPath: *const u8 // LPCSTR
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool PathCanonicalizeA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, [MarshalAs(UnmanagedType.LPStr)] string pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathCanonicalizeA' -Namespace Win32 -PassThru
# $api::PathCanonicalizeA(pszBuf, pszPath)#uselib "SHLWAPI.dll"
#func global PathCanonicalizeA "PathCanonicalizeA" sptr, sptr
; PathCanonicalizeA varptr(pszBuf), pszPath ; 戻り値は stat
; pszBuf : LPSTR out -> "sptr"
; pszPath : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global PathCanonicalizeA "PathCanonicalizeA" var, str ; res = PathCanonicalizeA(pszBuf, pszPath) ; pszBuf : LPSTR out -> "var" ; pszPath : LPCSTR -> "str" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global PathCanonicalizeA "PathCanonicalizeA" sptr, str ; res = PathCanonicalizeA(varptr(pszBuf), pszPath) ; pszBuf : LPSTR out -> "sptr" ; pszPath : LPCSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL PathCanonicalizeA(LPSTR pszBuf, LPCSTR pszPath) #uselib "SHLWAPI.dll" #cfunc global PathCanonicalizeA "PathCanonicalizeA" var, str ; res = PathCanonicalizeA(pszBuf, pszPath) ; pszBuf : LPSTR out -> "var" ; pszPath : LPCSTR -> "str" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL PathCanonicalizeA(LPSTR pszBuf, LPCSTR pszPath) #uselib "SHLWAPI.dll" #cfunc global PathCanonicalizeA "PathCanonicalizeA" intptr, str ; res = PathCanonicalizeA(varptr(pszBuf), pszPath) ; pszBuf : LPSTR out -> "intptr" ; pszPath : LPCSTR -> "str" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procPathCanonicalizeA = shlwapi.NewProc("PathCanonicalizeA")
)
// pszBuf (LPSTR out), pszPath (LPCSTR)
r1, _, err := procPathCanonicalizeA.Call(
uintptr(pszBuf),
uintptr(unsafe.Pointer(windows.BytePtrFromString(pszPath))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction PathCanonicalizeA(
pszBuf: PAnsiChar; // LPSTR out
pszPath: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathCanonicalizeA';result := DllCall("SHLWAPI\PathCanonicalizeA"
, "Ptr", pszBuf ; LPSTR out
, "AStr", pszPath ; LPCSTR
, "Int") ; return: BOOL●PathCanonicalizeA(pszBuf, pszPath) = DLL("SHLWAPI.dll", "bool PathCanonicalizeA(char*, char*)")
# 呼び出し: PathCanonicalizeA(pszBuf, pszPath)
# pszBuf : LPSTR out -> "char*"
# pszPath : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn PathCanonicalizeA(
pszBuf: [*c]u8, // LPSTR out
pszPath: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) i32;proc PathCanonicalizeA(
pszBuf: ptr char, # LPSTR out
pszPath: cstring # LPCSTR
): int32 {.importc: "PathCanonicalizeA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
int PathCanonicalizeA(
char* pszBuf, // LPSTR out
const(char)* pszPath // LPCSTR
);ccall((:PathCanonicalizeA, "SHLWAPI.dll"), stdcall, Int32,
(Ptr{UInt8}, Cstring),
pszBuf, pszPath)
# pszBuf : LPSTR out -> Ptr{UInt8}
# pszPath : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t PathCanonicalizeA(
char* pszBuf,
const char* pszPath);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.PathCanonicalizeA(pszBuf, pszPath)
-- pszBuf : LPSTR out
-- pszPath : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const PathCanonicalizeA = lib.func('__stdcall', 'PathCanonicalizeA', 'int32_t', ['char *', 'str']);
// PathCanonicalizeA(pszBuf, pszPath)
// pszBuf : LPSTR out -> 'char *'
// pszPath : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
PathCanonicalizeA: { parameters: ["buffer", "buffer"], result: "i32" },
});
// lib.symbols.PathCanonicalizeA(pszBuf, pszPath)
// pszBuf : LPSTR out -> "buffer"
// pszPath : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PathCanonicalizeA(
char* pszBuf,
const char* pszPath);
C, "SHLWAPI.dll");
// $ffi->PathCanonicalizeA(pszBuf, pszPath);
// pszBuf : LPSTR out
// pszPath : LPCSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shlwapi extends StdCallLibrary {
Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.ASCII_OPTIONS);
boolean PathCanonicalizeA(
byte[] pszBuf, // LPSTR out
String pszPath // LPCSTR
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun PathCanonicalizeA = PathCanonicalizeA(
pszBuf : UInt8*, # LPSTR out
pszPath : UInt8* # LPCSTR
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PathCanonicalizeANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef PathCanonicalizeADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final PathCanonicalizeA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<PathCanonicalizeANative, PathCanonicalizeADart>('PathCanonicalizeA');
// pszBuf : LPSTR out -> Pointer<Utf8>
// pszPath : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PathCanonicalizeA(
pszBuf: PAnsiChar; // LPSTR out
pszPath: PAnsiChar // LPCSTR
): BOOL; stdcall;
external 'SHLWAPI.dll' name 'PathCanonicalizeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PathCanonicalizeA"
c_PathCanonicalizeA :: CString -> CString -> IO CInt
-- pszBuf : LPSTR out -> CString
-- pszPath : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let pathcanonicalizea =
foreign "PathCanonicalizeA"
(string @-> string @-> returning int32_t)
(* pszBuf : LPSTR out -> string *)
(* pszPath : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)
(cffi:defcfun ("PathCanonicalizeA" path-canonicalize-a :convention :stdcall) :int32
(psz-buf :pointer) ; LPSTR out
(psz-path :string)) ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PathCanonicalizeA = Win32::API::More->new('SHLWAPI',
'BOOL PathCanonicalizeA(LPSTR pszBuf, LPCSTR pszPath)');
# my $ret = $PathCanonicalizeA->Call($pszBuf, $pszPath);
# pszBuf : LPSTR out -> LPSTR
# pszPath : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f PathCanonicalizeW (Unicode版) — 相対指定を解決しパスを正規形に整える。