StrNCatW

関数

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

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

シグネチャ

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

LPWSTR StrNCatW(
    LPWSTR psz1,
    LPCWSTR psz2,
    INT cchMax
);

パラメーター

名前	型	方向	説明
psz1	LPWSTR	inout	この関数が psz2 の文字を追加する先となる、null 終端文字列へのポインターです。結合後の文字列に終端の null 文字を加えたものを格納できるだけの十分な大きさが必要です。
psz2	LPCWSTR	in	追加される null 終端文字列へのポインターです。
cchMax	INT	in	psz2 の先頭から psz1 に追加する文字数です。

戻り値の型: LPWSTR

公式ドキュメント

ある文字列の先頭から指定された数の文字を、別の文字列の末尾に追加します。(Unicode)

戻り値

型: PTSTR

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

解説(Remarks)

セキュリティに関する警告: この関数を誤って使用すると、アプリケーションのセキュリティが損なわれるおそれがあります。第 1 引数 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  (Unicode / -W)
#include <windows.h>

LPWSTR StrNCatW(
    LPWSTR psz1,
    LPCWSTR psz2,
    INT cchMax
);

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

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

' psz1 : LPWSTR in/out
' psz2 : LPCWSTR
' cchMax : INT
Declare PtrSafe Function StrNCatW Lib "shlwapi" ( _
    ByVal psz1 As LongPtr, _
    ByVal psz2 As LongPtr, _
    ByVal cchMax 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

StrNCatW = ctypes.windll.shlwapi.StrNCatW
StrNCatW.restype = wintypes.LPWSTR
StrNCatW.argtypes = [
    wintypes.LPWSTR,  # psz1 : LPWSTR in/out
    wintypes.LPCWSTR,  # psz2 : LPCWSTR
    ctypes.c_int,  # cchMax : INT
]

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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