StrNCatA

関数

指定最大長まで文字列を連結する。

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

シグネチャ

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

LPSTR StrNCatA(
    LPSTR psz1,
    LPCSTR psz2,
    INT cchMax
);

パラメーター

名前	型	方向	説明
psz1	LPSTR	inout	psz2 の文字が追加される、null で終わる文字列へのポインターです。連結後の文字列と終端の null 文字を格納するのに十分な大きさが必要です。
psz2	LPCSTR	in	追加される、null で終わる文字列へのポインターです。
cchMax	INT	in	psz2 の先頭から psz1 に追加する文字数です。

戻り値の型: LPSTR

公式ドキュメント

一方の文字列の先頭から指定された数の文字を、もう一方の文字列の末尾に追加します。(ANSI)

戻り値

型: PTSTR

連結後の文字列を保持する psz1 へのポインターを返します。

解説(Remarks)

セキュリティに関する警告: この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。最初の引数 psz1 は、psz2 と終端の '\0' を格納できる十分な大きさが必要です。そうでない場合、バッファーオーバーランが発生する可能性があります。バッファーオーバーランは、アクセス違反が発生した場合にアプリケーションに対するサービス拒否攻撃につながる可能性があります。最悪の場合、特に psz1 がスタックベースのバッファーであるときには、バッファーオーバーランによって攻撃者がプロセスに実行可能コードを挿入できるようになる可能性があります。最後の引数 cchMax は psz1 にコピーする文字数であり、必ずしも psz1 のバイト単位のサイズではないことに注意してください。次のいずれかの代替手段の使用を検討してください。StringCbCat、StringCbCatEx、StringCbCatN、StringCbCatNEx、StringCchCat、StringCchCatEx、StringCchCatN、または StringCchCatNEx。続行する前に、セキュリティに関する考慮事項: Microsoft Windows シェルを確認してください。

メモ

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

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

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

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

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

import ctypes
from ctypes import wintypes

StrNCatA = ctypes.windll.shlwapi.StrNCatA
StrNCatA.restype = wintypes.LPSTR
StrNCatA.argtypes = [
    wintypes.LPSTR,  # psz1 : LPSTR in/out
    wintypes.LPCSTR,  # psz2 : LPCSTR
    ctypes.c_int,  # cchMax : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrNCatA = Fiddle::Function.new(
  lib['StrNCatA'],
  [
    Fiddle::TYPE_VOIDP,  # psz1 : LPSTR in/out
    Fiddle::TYPE_VOIDP,  # psz2 : LPCSTR
    Fiddle::TYPE_INT,  # cchMax : INT
  ],
  Fiddle::TYPE_VOIDP)

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

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

出力引数:

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