StringCbCatExW 関数 (strsafe.h)
1 つの文字列を別の文字列に連結します。 コピー先バッファーのサイズは、このバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。
StringCbCatEx は 、宛先文字列の末尾へのポインターと、その文字列で使用されていない残りのバイト数を返すことによって 、StringCbCat の機能を追加します。 フラグは、追加の制御のために関数に渡すこともできます。
StringCbCatEx は、次の関数に代わる関数です。
構文
STRSAFEAPI StringCbCatExW(
[in, out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCWSTR pszSrc,
[out, optional] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
パラメーター
[in, out] pszDest
種類: LPTSTR
pszSrc を連結する文字列。結果の文字列全体を受け取ります。 pszSrc の文字列は、pszDest の文字列の末尾に追加されます。
[in] cbDest
種類: size_t
コピー先バッファーのサイズ (バイト単位)。 この値は、 pszSrc の長さと pszDest の長さと終端の null 文字を考慮する必要があります。 許容される最大バイト数は です STRSAFE_MAX_CCH * sizeof(TCHAR)
。
[in] pszSrc
種類: LPCTSTR
pszDest の末尾に連結されるソース文字列。 この文字列は null で終わる必要があります。
[out, optional] ppszDestEnd
種類: LPTSTR*
pszDest の末尾へのポインターのアドレス。 ppszDestEnd が NULL 以外で、コピー先バッファーにデータが追加された場合、これは文字列の末尾にある終端の null 文字を指します。
[out, optional] pcbRemaining
種類: size_t*
pszDest の未使用バイト数 (終端の null 文字に使用されたものも含む)。 pcbRemaining が NULL の場合、カウントは保持されず、返されません。
[in] dwFlags
型: DWORD
次の値のうち 1 つ以上。
値 | 意味 |
---|---|
|
関数が成功した場合、 dwFlags (0) の下位バイトを使用して、終端の null 文字の後に pszDest の初期化されていない部分を埋めます。 |
|
NULL 文字列ポインターを空の文字列 (TEXT("")) のように扱います。 このフラグは、 lstrcpy などの関数をエミュレートする場合に便利です。 |
|
関数が失敗した場合、 dwFlags (0) の下位バイトを使用して pszDest バッファー全体を埋め、バッファーは null で終了します。 STRSAFE_E_INSUFFICIENT_BUFFERエラーが発生した場合は、コピー先バッファー内の既存の文字列または切り捨てられた文字列が上書きされます。 |
|
関数が失敗した場合、 pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFERエラーが発生した場合は、コピー先バッファー内の既存の文字列または切り捨てられた文字列が上書きされます。 |
|
関数が失敗した場合、 pszDest は変更されません。 元のコンテンツには何も追加されません。 |
戻り値
型: HRESULT
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、 SUCCEEDED マクロと FAILED マクロを使用することを強くお勧めします。
リターン コード | 説明 |
---|---|
|
ソース データが存在し、文字列は切り捨てずに完全に連結され、結果の宛先バッファーは null で終了します。 |
|
cbDest の値は、許容される最大値よりsizeof(TCHAR) 小さいか、より大きいかのいずれかです。
|
|
バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlags の値によっては、ターゲット バッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。 |
この関数は、置き換える関数とは異なり、 HRESULT 値を返します。
注釈
StringCbCatEx は、コード内で適切なバッファー処理を行うための追加の処理を提供します。 バッファーの処理が不十分な場合は、バッファー オーバーランを伴う多くのセキュリティの問題に関係します。 StringCbCatEx は 常に null 終了し、操作中にソース文字列の内容が変更された場合でも、有効な宛先バッファーをオーバーフローすることはありません。
pszSrc と pszDest が指す文字列が重複している場合、動作は未定義です。
STRSAFE_IGNORE_NULLS フラグが指定されていない限り、pszSrc も pszDest も NULL にすることはできません。この場合、両方とも NULL である可能性があります。 ただし、 NULL 値が無視されても、領域が不足しているためにエラーが返される可能性があります。
StringCbCatEx は、一般的な形式で使用することも、より具体的な形式で使用することもできます。 次の表に示すように、文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。
文字列型 (String) | リテラル文字列 | 機能 |
---|---|---|
char | "string" | StringCbCatExA |
TCHAR | TEXT("string") | StringCbCatEx |
Wchar | L"string" | StringCbCatExW |
注意
strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCbCatEx を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | SP2 を使用した Windows XP [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | WINDOWS Server 2003 SP1 [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | strsafe.h |
関連項目
参照