StrCatBuffA

関数

バッファサイズを超えないように文字列を連結する。

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

シグネチャ

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

LPSTR StrCatBuffA(
    LPSTR pszDest,
    LPCSTR pszSrc,
    INT cchDestBuffSize
);

パラメーター

名前	型	方向	説明
pszDest	LPSTR	inout	null で終端された文字列へのポインター。この関数が正常に終了すると、この文字列には元の内容に文字列 pszSrc が追加されたものが格納されます。
pszSrc	LPCSTR	in	pszDest に追加する文字列へのポインター。
cchDestBuffSize	INT	in	pszDest が指すバッファーのサイズ(文字数)。この値は、結合後の文字列の長さに終端の null 文字を加えた長さ以上である必要があります。バッファーが小さすぎて文字列全体を格納できない場合、文字列は切り詰められます。

戻り値の型: LPSTR

公式ドキュメント

ある文字列の末尾に、別の文字列の文字をコピーして追加します。(ANSI)

戻り値

型: PTSTR

変換先の文字列へのポインターを返します。

解説(Remarks)

セキュリティに関する警告: この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。最終的な文字列が null で終端されることは保証されません。次のいずれかの代替手段の使用を検討してください: StringCbCat、StringCbCatEx、StringCbCatN、StringCbCatNEx、StringCchCat、StringCchCatEx、StringCchCatN、または StringCchCatNEx。続行する前に、セキュリティに関する考慮事項: Microsoft Windows シェルを確認してください。

メモ

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

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

LPSTR StrCatBuffA(
    LPSTR pszDest,
    LPCSTR pszSrc,
    INT cchDestBuffSize
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr StrCatBuffA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest,   // LPSTR in/out
    [MarshalAs(UnmanagedType.LPStr)] string pszSrc,   // LPCSTR
    int cchDestBuffSize   // INT
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrCatBuffA(
    <MarshalAs(UnmanagedType.LPStr)> pszDest As System.Text.StringBuilder,   ' LPSTR in/out
    <MarshalAs(UnmanagedType.LPStr)> pszSrc As String,   ' LPCSTR
    cchDestBuffSize As Integer   ' INT
) As IntPtr
End Function

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

import ctypes
from ctypes import wintypes

StrCatBuffA = ctypes.windll.shlwapi.StrCatBuffA
StrCatBuffA.restype = wintypes.LPSTR
StrCatBuffA.argtypes = [
    wintypes.LPSTR,  # pszDest : LPSTR in/out
    wintypes.LPCSTR,  # pszSrc : LPCSTR
    ctypes.c_int,  # cchDestBuffSize : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrCatBuffA = Fiddle::Function.new(
  lib['StrCatBuffA'],
  [
    Fiddle::TYPE_VOIDP,  # pszDest : LPSTR in/out
    Fiddle::TYPE_VOIDP,  # pszSrc : LPCSTR
    Fiddle::TYPE_INT,  # cchDestBuffSize : INT
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "shlwapi")]
extern "system" {
    fn StrCatBuffA(
        pszDest: *mut u8,  // LPSTR in/out
        pszSrc: *const u8,  // LPCSTR
        cchDestBuffSize: i32  // INT
    ) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr StrCatBuffA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszDest, [MarshalAs(UnmanagedType.LPStr)] string pszSrc, int cchDestBuffSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrCatBuffA' -Namespace Win32 -PassThru
# $api::StrCatBuffA(pszDest, pszSrc, cchDestBuffSize)

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

出力引数:

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