ホーム › UI.Shell › PathCompactPathExW

PathCompactPathExW

関数

指定の文字数に収まるよう、パスを省略記号付きで短縮する。

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

シグネチャ

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

BOOL PathCompactPathExW(
    LPWSTR pszOut,
    LPCWSTR pszSrc,
    DWORD cchMax,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
pszOut	LPWSTR	out	変更後の文字列のアドレス。
pszSrc	LPCWSTR	in	変更対象のパスを含む、長さ MAX_PATH の null 終端文字列へのポインター。
cchMax	DWORD	in	終端の null 文字を含めて、新しい文字列に格納できる最大文字数。たとえば cchMax = 8 の場合、結果の文字列には終端の null 文字に加えて最大 7 文字を格納できます。
dwFlags	DWORD	in

戻り値の型: BOOL

公式ドキュメント

パスコンポーネントを省略記号(...)に置き換えることで、パスを指定した文字数以内に収まるように切り詰めます。(Unicode)

戻り値

型: BOOL

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

元の文字列が '/' を使用していた場合は、'\' の代わりに '/' 区切り文字が使用されます。pszSrc がパスではなく長すぎるファイル名を指している場合、ファイル名は省略記号と終端の NULL 文字を含めて cchMax 文字に切り詰められます。たとえば、入力ファイル名が "My Filename" で cchMax が 10 の場合、PathCompactPathEx は "My Fil..." を返します。

メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして PathCompactPathEx を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不整合が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL PathCompactPathExW(
    LPWSTR pszOut,
    LPCWSTR pszSrc,
    DWORD cchMax,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool PathCompactPathExW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOut,   // LPWSTR out
    [MarshalAs(UnmanagedType.LPWStr)] string pszSrc,   // LPCWSTR
    uint cchMax,   // DWORD
    uint dwFlags   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PathCompactPathExW(
    <MarshalAs(UnmanagedType.LPWStr)> pszOut As System.Text.StringBuilder,   ' LPWSTR out
    <MarshalAs(UnmanagedType.LPWStr)> pszSrc As String,   ' LPCWSTR
    cchMax As UInteger,   ' DWORD
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pszOut : LPWSTR out
' pszSrc : LPCWSTR
' cchMax : DWORD
' dwFlags : DWORD
Declare PtrSafe Function PathCompactPathExW Lib "shlwapi" ( _
    ByVal pszOut As LongPtr, _
    ByVal pszSrc As LongPtr, _
    ByVal cchMax As Long, _
    ByVal dwFlags As Long) As Long
' 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

PathCompactPathExW = ctypes.windll.shlwapi.PathCompactPathExW
PathCompactPathExW.restype = wintypes.BOOL
PathCompactPathExW.argtypes = [
    wintypes.LPWSTR,  # pszOut : LPWSTR out
    wintypes.LPCWSTR,  # pszSrc : LPCWSTR
    wintypes.DWORD,  # cchMax : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathCompactPathExW = Fiddle::Function.new(
  lib['PathCompactPathExW'],
  [
    Fiddle::TYPE_VOIDP,  # pszOut : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pszSrc : LPCWSTR
    -Fiddle::TYPE_INT,  # cchMax : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shlwapi")]
extern "system" {
    fn PathCompactPathExW(
        pszOut: *mut u16,  // LPWSTR out
        pszSrc: *const u16,  // LPCWSTR
        cchMax: u32,  // DWORD
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern bool PathCompactPathExW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszOut, [MarshalAs(UnmanagedType.LPWStr)] string pszSrc, uint cchMax, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathCompactPathExW' -Namespace Win32 -PassThru
# $api::PathCompactPathExW(pszOut, pszSrc, cchMax, dwFlags)

#uselib "SHLWAPI.dll"
#func global PathCompactPathExW "PathCompactPathExW" wptr, wptr, wptr, wptr
; PathCompactPathExW varptr(pszOut), pszSrc, cchMax, dwFlags   ; 戻り値は stat
; pszOut : LPWSTR out -> "wptr"
; pszSrc : LPCWSTR -> "wptr"
; cchMax : DWORD -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global PathCompactPathExW "PathCompactPathExW" var, wstr, int, int
; res = PathCompactPathExW(pszOut, pszSrc, cchMax, dwFlags)
; pszOut : LPWSTR out -> "var"
; pszSrc : LPCWSTR -> "wstr"
; cchMax : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global PathCompactPathExW "PathCompactPathExW" sptr, wstr, int, int
; res = PathCompactPathExW(varptr(pszOut), pszSrc, cchMax, dwFlags)
; pszOut : LPWSTR out -> "sptr"
; pszSrc : LPCWSTR -> "wstr"
; cchMax : DWORD -> "int"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。