PathMakePrettyW

関数

パスをすべて小文字に変換し見やすい表記に整える。

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

シグネチャ

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

BOOL PathMakePrettyW(
    LPWSTR pszPath
);

パラメーター

名前	型	方向	説明
pszPath	LPWSTR	inout	変換対象のパスを含む、長さ MAX_PATH の null 終端文字列へのポインター。

戻り値の型: BOOL

公式ドキュメント

すべて大文字のパスをすべて小文字の文字に変換し、パスの外観を統一します。(Unicode)

戻り値

型: BOOL

パスが変換された場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

この関数は、すべて大文字で構成されたパスに対してのみ動作します。たとえば、C:\WINDOWS は c:\windows に変換されますが、c:\Windows は変更されません。

例

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

void main( void )
{
// Path name 1.
char buffer_1[ ] = "C:\\TEST\\FILE";
char *lpStr1;
lpStr1 = buffer_1;

// Path name 2.
char buffer_2[ ] = "c:\\test\\file";
char *lpStr2;
lpStr2 = buffer_2;

// Test path name 1.
    cout << "The content of the unconverted path is : " << lpStr1 << endl;
    cout << "The \"PathMakePretty\" function returns the value " 
         << PathMakePretty(lpStr1) << "  = TRUE & converts"  << endl;
    cout << "The content of the converted path is   : " << lpStr1 << endl;

// Test path name 2.
    cout << "\nThe content of the unconverted path is : " << lpStr2 << endl;
    cout << "The \"PathMakePretty\" function returns the value " 
         << PathMakePretty(lpStr2) << "  = FALSE & no conversion"  << endl;
    cout << "The content of the converted path is   : " << lpStr2 << endl;
}

OUTPUT:
=============
The content of the unconverted path is : C:\TEST\FILE
The "PathMakePretty" function returns the value 1  = TRUE & converts
The content of the converted path is   : C:\test\file

The content of the unconverted path is : c:\test\file
The "PathMakePretty" function returns the value 0  = FALSE & no conversion
The content of the converted path is   : c:\test\file

メモ

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

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

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

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

' pszPath : LPWSTR in/out
Declare PtrSafe Function PathMakePrettyW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr) 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "shlwapi")]
extern "system" {
    fn PathMakePrettyW(
        pszPath: *mut u16  // LPWSTR in/out
    ) -> 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 PathMakePrettyW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszPath);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_PathMakePrettyW' -Namespace Win32 -PassThru
# $api::PathMakePrettyW(pszPath)

#uselib "SHLWAPI.dll"
#func global PathMakePrettyW "PathMakePrettyW" wptr
; PathMakePrettyW varptr(pszPath)   ; 戻り値は stat
; pszPath : LPWSTR in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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