PathAppendA

関数

パスに別のパス要素を連結する。

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

シグネチャ

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

BOOL PathAppendA(
    LPSTR pszPath,
    LPCSTR pszMore
);

パラメーター

名前	型	方向	説明
pszPath	LPSTR	inout	pszMore で指定されたパスが追加される、null 終端文字列へのポインターです。返される文字列を格納するのに十分な大きさを確保するため、このバッファーのサイズは MAX_PATH に設定する必要があります。
pszMore	LPCSTR	in	追加するパスを格納した、最大長 MAX_PATH の null 終端文字列へのポインターです。

戻り値の型: BOOL

公式ドキュメント

あるパスの末尾に別のパスを追加します。(ANSI)

戻り値

型: BOOL

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

解説(Remarks)

この関数は、2 つの文字列の間にバックスラッシュがまだ存在しない場合、自動的にバックスラッシュを挿入します。

pszPath に指定するパスは、相対パス文字列を生成するための "..\" や ".\" で始めることはできません。これらが存在する場合、それらのピリオドは出力文字列から取り除かれます。たとえば、"..\path1\path2" に "path3" を追加すると、出力は "..\path1\path2\path3" ではなく "\path1\path2\path3" になります。

例


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

using namespace std;

int main( void )
{
    // String for path name.
    char buffer_1[MAX_PATH] = "name_1\\name_2";
    char *lpStr1;
    lpStr1 = buffer_1;

    // String of what is being added.
    char buffer_2[ ] = "name_3";
    char *lpStr2;
    lpStr2 = buffer_2;

    cout << "The original path string is    " << lpStr1 << endl;
    cout << "The part to append to end is   " << lpStr2 << endl;
    bool ret = PathAppend(lpStr1,lpStr2);
    cout << "The appended path string is    " << lpStr1 << endl;
}

OUTPUT:
--------- 
The original path string is    name_1\name_2
The part to append to end is   name_3
The appended path string is    name_1\name_2\name_3

メモ

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

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

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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