ホーム › UI.Shell › PathCompactPathA

PathCompactPathA

関数

指定のピクセル幅に収まるよう、パス文字列を省略記号で短縮する。

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

シグネチャ

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL PathCompactPathA(
    HDC hDC,   // optional
    LPSTR pszPath,
    DWORD dx
);

パラメーター

名前	型	方向	説明
hDC	HDC	inoptional	フォントメトリックの取得に使用するデバイスコンテキストへのハンドル。この値は NULL でもかまいません。
pszPath	LPSTR	inout	変更対象のパスを格納した、長さ MAX_PATH の null 終端文字列へのポインター。戻り時には、このバッファーに変更後の文字列が格納されます。
dx	DWORD	in	文字列が収まるべき幅(ピクセル単位)。

戻り値の型: BOOL

公式ドキュメント

パスのコンポーネントを省略記号に置き換えることで、ファイルパスを指定したピクセル幅に収まるように切り詰めます。(ANSI)

戻り値

型: BOOL

パスを指定した幅に正常に収められた場合は TRUE を返します。失敗した場合、またはパスの基本部分が指定した幅に収まらない場合は FALSE を返します。

解説(Remarks)

この関数は、hDC で現在選択されているフォントを使用してテキストの幅を計算します。この関数は、省略記号を先頭に付けた基本ファイル名を超えてパスを圧縮することはありません。

例

#include <windows.h>
#include <iostream.h>
#include "Shlwapi.h"

HDC hdc;  /* display DC handle to current font metrics */ 

void main( void )
{
// String path name 1.
char buffer_1[MAX_PATH] = "C:\\path1\\path2\\sample.txt";
char *lpStr1;
lpStr1 = buffer_1;

// String path name 2.
char buffer_2[MAX_PATH] = "C:\\path1\\path2\\sample.txt";
char *lpStr2;
lpStr2 = buffer_2;

// String path name 3.
char buffer_3[MAX_PATH] = "C:\\path1\\path2\\sample.txt";
char *lpStr3;
lpStr3 = buffer_3;

// String path name 4.
char buffer_4[MAX_PATH] = "C:\\path1\\path2\\sample.txt";
char *lpStr4;
lpStr4 = buffer_4;

// Variable to get the return from "PathCompactPath".
int retval;

cout << "The un-truncated path is                " << lpStr1 << endl;

retval = PathCompactPath(hdc,lpStr1,125);
cout << "The truncated path at 125 pixels is :   " << lpStr1 << endl;

retval = PathCompactPath(hdc,lpStr2,120);
cout << "The truncated path at 120 pixels is :   " << lpStr2 << endl;

retval = PathCompactPath(hdc,lpStr3,110);
cout << "The truncated path at 110 pixels is :   " << lpStr3 << endl;

retval = PathCompactPath(hdc,lpStr4,25);
cout << "The truncated path at  25 pixels is :   " << lpStr4 << endl;
}

OUTPUT:
===========
The un-truncated path is                C:\path1\path2\sample.txt
The truncated path at 125 pixels is :   C:\path1\...\sample.txt
The truncated path at 120 pixels is :   C:\pat...\sample.txt
The truncated path at 110 pixels is :   C:\p...\sample.txt
The truncated path at  25 pixels is :   ...\sample.txt

メモ

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

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

各言語での呼び出し定義

// SHLWAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL PathCompactPathA(
    HDC hDC,   // optional
    LPSTR pszPath,
    DWORD dx
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathCompactPathA(
    IntPtr hDC,   // HDC optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath,   // LPSTR in/out
    uint dx   // DWORD
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathCompactPathA(
    hDC As IntPtr,   ' HDC optional
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder,   ' LPSTR in/out
    dx As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hDC : HDC optional
' pszPath : LPSTR in/out
' dx : DWORD
Declare PtrSafe Function PathCompactPathA Lib "shlwapi" ( _
    ByVal hDC As LongPtr, _
    ByVal pszPath As String, _
    ByVal dx As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PathCompactPathA = ctypes.windll.shlwapi.PathCompactPathA
PathCompactPathA.restype = wintypes.BOOL
PathCompactPathA.argtypes = [
    wintypes.HANDLE,  # hDC : HDC optional
    wintypes.LPSTR,  # pszPath : LPSTR in/out
    wintypes.DWORD,  # dx : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathCompactPathA = Fiddle::Function.new(
  lib['PathCompactPathA'],
  [
    Fiddle::TYPE_VOIDP,  # hDC : HDC optional
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR in/out
    -Fiddle::TYPE_INT,  # dx : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "shlwapi")]
extern "system" {
    fn PathCompactPathA(
        hDC: *mut core::ffi::c_void,  // HDC optional
        pszPath: *mut u8,  // LPSTR in/out
        dx: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern bool PathCompactPathA(IntPtr hDC, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath, uint dx);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathCompactPathA' -Namespace Win32 -PassThru
# $api::PathCompactPathA(hDC, pszPath, dx)

#uselib "SHLWAPI.dll"
#func global PathCompactPathA "PathCompactPathA" sptr, sptr, sptr
; PathCompactPathA hDC, varptr(pszPath), dx   ; 戻り値は stat
; hDC : HDC optional -> "sptr"
; pszPath : LPSTR in/out -> "sptr"
; dx : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHLWAPI.dll"
#cfunc global PathCompactPathA "PathCompactPathA" sptr, var, int
; res = PathCompactPathA(hDC, pszPath, dx)
; hDC : HDC optional -> "sptr"
; pszPath : LPSTR in/out -> "var"
; dx : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll"
#cfunc global PathCompactPathA "PathCompactPathA" sptr, sptr, int
; res = PathCompactPathA(hDC, varptr(pszPath), dx)
; hDC : HDC optional -> "sptr"
; pszPath : LPSTR in/out -> "sptr"
; dx : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。