StrCatBuffW

関数

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

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

シグネチャ

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

LPWSTR StrCatBuffW(
    LPWSTR pszDest,
    LPCWSTR pszSrc,
    INT cchDestBuffSize
);

パラメーター

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

戻り値の型: LPWSTR

公式ドキュメント

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

戻り値

型: PTSTR

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

解説(Remarks)

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

メモ

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

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

LPWSTR StrCatBuffW(
    LPWSTR pszDest,
    LPCWSTR pszSrc,
    INT cchDestBuffSize
);

[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr StrCatBuffW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszDest,   // LPWSTR in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pszSrc,   // LPCWSTR
    int cchDestBuffSize   // INT
);

<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrCatBuffW(
    <MarshalAs(UnmanagedType.LPWStr)> pszDest As System.Text.StringBuilder,   ' LPWSTR in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszSrc As String,   ' LPCWSTR
    cchDestBuffSize As Integer   ' INT
) As IntPtr
End Function

' pszDest : LPWSTR in/out
' pszSrc : LPCWSTR
' cchDestBuffSize : INT
Declare PtrSafe Function StrCatBuffW Lib "shlwapi" ( _
    ByVal pszDest As LongPtr, _
    ByVal pszSrc As LongPtr, _
    ByVal cchDestBuffSize As Long) As LongPtr
' 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

StrCatBuffW = ctypes.windll.shlwapi.StrCatBuffW
StrCatBuffW.restype = wintypes.LPWSTR
StrCatBuffW.argtypes = [
    wintypes.LPWSTR,  # pszDest : LPWSTR in/out
    wintypes.LPCWSTR,  # pszSrc : LPCWSTR
    ctypes.c_int,  # cchDestBuffSize : INT
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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