ホーム › UI.Shell › PathAddExtensionA

PathAddExtensionA

関数

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

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

シグネチャ

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

BOOL PathAddExtensionA(
    LPSTR pszPath,
    LPCSTR pszExt   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: 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 ヘッダーは PathAddExtension を、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  (ANSI / -A)
#include <windows.h>

BOOL PathAddExtensionA(
    LPSTR pszPath,
    LPCSTR pszExt   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool PathAddExtensionA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszPath,   // LPSTR in/out
    [MarshalAs(UnmanagedType.LPStr)] string pszExt   // LPCSTR optional
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function PathAddExtensionA(
    <MarshalAs(UnmanagedType.LPStr)> pszPath As System.Text.StringBuilder,   ' LPSTR in/out
    <MarshalAs(UnmanagedType.LPStr)> pszExt As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

PathAddExtensionA = ctypes.windll.shlwapi.PathAddExtensionA
PathAddExtensionA.restype = wintypes.BOOL
PathAddExtensionA.argtypes = [
    wintypes.LPSTR,  # pszPath : LPSTR in/out
    wintypes.LPCSTR,  # pszExt : LPCSTR optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
PathAddExtensionA = Fiddle::Function.new(
  lib['PathAddExtensionA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPath : LPSTR in/out
    Fiddle::TYPE_VOIDP,  # pszExt : LPCSTR optional
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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