StringCbCatNA 関数 (strsafe.h)

  • [アーティクル]

指定したバイト数を 1 つの文字列から別の文字列に連結します。 コピー先バッファーのサイズ (バイト単位) が関数に提供され、このバッファーの末尾を越えて書き込まれないことを確認します。

StringCbCatN は、次の関数に代わる関数です。

構文

STRSAFEAPI StringCbCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cbToAppend
);

パラメーター

[in, out] pszDest

種類: LPTSTR

pszSrc に連結する文字列を格納し、結果の文字列を受け取る宛先バッファー。 pszSrc の文字列 (cbMaxAppend バイトまで) は、pszDest の文字列の末尾に追加されます。

[in] cbDest

種類: size_t

コピー先バッファーのサイズ (バイト単位)。 この値は、 pszSrc の長さと pszDest または cbMaxAppend の長さ (どちらか小さい方) と終端の null 文字を加えた値を考慮する必要があります。 許容される最大バイト数は です STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszSrc

型: LPCTSTR

pszDest の末尾に連結されるソース文字列。 このソース文字列は null で終わる必要があります。

[in] cbToAppend

種類: size_t

pszDest に追加する最大バイト数。

戻り値

種類: HRESULT

この関数は、次のいずれかの値を返すことができます。 SUCCEEDED マクロと FAILED マクロを使用して、この関数の戻り値をテストすることを強くお勧めします。

リターン コード 説明
S_OK
 ソース データが存在し、文字列が切り捨てられずに連結され、結果の宛先バッファーは null で終わる。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値が許容される最大値より大きいか、宛先バッファーが既にいっぱいです。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、連結操作に失敗しました。 変換先バッファーには、意図した結果の、null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしもエラー状態と見なされない場合があります。
 

この関数は、置き換える関数とは異なり、 HRESULT 値を返します。

注釈

StringCbCatN は、置き換える関数と比較して、コード内で適切なバッファー処理を行うための追加処理を提供します。 バッファー処理の不十分さは、バッファー オーバーランを伴う多くのセキュリティの問題に関係しています。 StringCbCatN は 常に null 終了し、操作中にソース文字列の内容が変更された場合でも、有効な宛先バッファーをオーバーフローすることはありません。

pszSrc と pszDest が指す文字列が重複している場合、動作は未定義です。

pszSrc も pszDest も NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCbCatNEx 」を参照してください。

StringCbCatN は、一般的な形式またはより具体的な形式で使用できます。 文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。

文字列型 (String) リテラル文字列 機能
char "string" StringCbCatNA
TCHAR TEXT("string") StringCbCatN
Wchar L"string" StringCbCatNW
 

注意

strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCbCatN を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント WINDOWS XP と SP2 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー strsafe.h

関連項目

参照

StringCbCat

StringCbCatNEx

StringCchCatN