PathUndecorateW

関数

ファイル名に付いた連番などの装飾を取り除く。

DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

void PathUndecorateW(
    LPWSTR pszPath
);

パラメーター

名前	型	方向	説明
pszPath	LPWSTR	inout	パスを含む、長さ MAX_PATH の null 終端文字列です。関数が返るとき、pszPath は装飾が削除された文字列を指します。

戻り値の型: void

公式ドキュメント

パス文字列から装飾を削除します。(Unicode)

解説(Remarks)

装飾とは、ベース名の直後かつファイル名拡張子の前に挿入される、1 つ以上の数字を角かっこで囲んだものです。

例

次の表は、PathUndecorate によって文字列がどのように変更されるかを示しています。

元の文字列	装飾を削除した文字列
C:\Path\File[5].txt	C:\Path\File.txt
C:\Path\File[12]	C:\Path\File
C:\Path\File.txt	C:\Path\File.txt
C:\Path\[3].txt	C:\Path\[3].txt

メモ

shlwapi.h ヘッダーは PathUndecorate をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// SHLWAPI.dll  (Unicode / -W)
#include <windows.h>

void PathUndecorateW(
    LPWSTR pszPath
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void PathUndecorateW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath   // LPWSTR in/out
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub PathUndecorateW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPath As System.Text.StringBuilder   ' LPWSTR in/out
)
End Sub

' pszPath : LPWSTR in/out
Declare PtrSafe Sub PathUndecorateW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr)
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathUndecorateW = ctypes.windll.shlwapi.PathUndecorateW
PathUndecorateW.restype = None
PathUndecorateW.argtypes = [
    wintypes.LPWSTR,  # pszPath : LPWSTR in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathUndecorateW = Fiddle::Function.new(
  lib['PathUndecorateW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPWSTR in/out
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn PathUndecorateW(
        pszPath: *mut u16  // LPWSTR in/out
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern void PathUndecorateW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathUndecorateW' -Namespace Win32 -PassThru
# $api::PathUndecorateW(pszPath)

#uselib "SHLWAPI.dll"
#func global PathUndecorateW "PathUndecorateW" wptr
; PathUndecorateW varptr(pszPath)
; pszPath : LPWSTR in/out -> "wptr"

出力引数:

#uselib "SHLWAPI.dll"
#func global PathUndecorateW "PathUndecorateW" var
; PathUndecorateW pszPath
; pszPath : LPWSTR in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#func global PathUndecorateW "PathUndecorateW" sptr
; PathUndecorateW varptr(pszPath)
; pszPath : LPWSTR in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。