ホーム › UI.Shell › PathAddExtensionW

PathAddExtensionW

関数

パスに指定した拡張子を付加する。

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

シグネチャ

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

BOOL PathAddExtensionW(
    LPWSTR pszPath,
    LPCWSTR pszExt   // optional
);

パラメーター

名前	型	方向	説明
pszPath	LPWSTR	inout	ファイル名拡張子が追加される、null 終端文字列を格納したバッファーへのポインター。返される文字列を確実に格納できるよう、このバッファーのサイズは MAX_PATH に設定する必要があります。
pszExt	LPCWSTR	inoptional	ファイル名拡張子を格納した null 終端文字列へのポインター。この値は NULL でもかまいません。

戻り値の型: BOOL

公式ドキュメント

パス文字列にファイル名拡張子を追加します。(Unicode)

戻り値

型: BOOL

拡張子が追加された場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

既にファイル名拡張子が存在する場合は、拡張子は追加されません。pszPath が NULL 文字列を指している場合、結果はファイル名拡張子のみになります。pszExtension が NULL 文字列を指している場合は、".exe" 拡張子が追加されます。

例

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

void main( void )
{
     // String for path name without file name extension.
     char buffer_1[MAX_PATH] = "file";
     char *lpStr1;
     lpStr1 = buffer_1;

     // String for path name with file name extension.
     char buffer_2[ ] = "file.doc";
     char *lpStr2;
     lpStr2 = buffer_2;

     // String for extension name.
     char F_Ext[MAX_PATH] = ".txt";
     char *lpStr3;
     lpStr3 = F_Ext;

     // Null string as path. 
     char N_String[MAX_PATH] = "\0";
     char *lpStr4;
     lpStr4 = N_String;

     // Path 1 without the file name extension.
     cout << "The original path string 1 is  " << lpStr1 << endl;

     int ret_1 = PathAddExtension(lpStr1,lpStr3);
     cout << "The modified path string 1 is  " << lpStr1 << endl;

    // Path 2 with the file name extension already there.
    cout << "The original path string 2 is  " << lpStr2 << endl;
    int ret_2 = PathAddExtension(lpStr2,lpStr3);
    cout << "The modified path string 2 is  " << lpStr2<< endl;

    // Path 3 null string as a path.
    int ret_3 = PathAddExtension(lpStr4,lpStr3);
    cout << "The return value is " << ret_3<< endl;
    cout << "The modified path on a null string is " << lpStr4<< endl;

}

OUTPUT:
-----------------------
The original path string 1 is  file
The modified path string 1 is  file.txt
The original path string 2 is  file.doc
The modified path string 2 is  file.doc
The return value is 1
The modified path on a null string is .txt
The return value is 1

メモ

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

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

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

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

' pszPath : LPWSTR in/out
' pszExt : LPCWSTR optional
Declare PtrSafe Function PathAddExtensionW Lib "shlwapi" ( _
    ByVal pszPath As LongPtr, _
    ByVal pszExt 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

PathAddExtensionW = ctypes.windll.shlwapi.PathAddExtensionW
PathAddExtensionW.restype = wintypes.BOOL
PathAddExtensionW.argtypes = [
    wintypes.LPWSTR,  # pszPath : LPWSTR in/out
    wintypes.LPCWSTR,  # pszExt : LPCWSTR optional
]

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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