StringCbCopyNA 関数 (strsafe.h)

  • [アーティクル]

指定したバイト数を 1 つの文字列から別の文字列にコピーします。 コピー先バッファーのサイズは、このバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。

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

構文

STRSAFEAPI StringCbCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cbToCopy
);

パラメーター

[out] pszDest

種類: LPTSTR

コピーされた文字を受け取る宛先バッファー。

[in] cbDest

種類: size_t

pszDest のサイズ (バイト単位)。 この値は、コピーされたバイト ( pszSrc のサイズまたは cbSrc の値のいずれか小さい方) を保持するのに十分な大きさである必要があり、終端の null 文字も考慮する必要があります。 使用できる最大文字数は です STRSAFE_MAX_CCH * sizeof(TCHAR)。

[in] pszSrc

種類: LPCTSTR

ソース文字列。 この文字列は null で終わる必要があります。

[in] cbToCopy

種類: size_t

pszSrc から pszDest にコピーされる最大バイト数。

戻り値

型: HRESULT

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

リターン コード 説明
S_OK
 ソース データが存在し、切り捨てなしで pszSrc からデータがコピーされ、結果の宛先バッファーが null で終了しました。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値が よりSTRSAFE_MAX_CCH * sizeof(TCHAR)大きいか、宛先バッファーが既にいっぱいです。
STRSAFE_E_INSUFFICIENT_BUFFER
 バッファー領域が不足しているため、コピー操作に失敗しました。 コピー先バッファーには、目的の結果の null で終わる切り捨てられたバージョンが含まれています。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。
 

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

注釈

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

このルーチンは strncpy の代わりとして使用されますが、動作には違いがあります。 cbSrc が pszSrc のバイト数より大きい場合、stringCbCopyN は strncpy とは異なり、cbSrc バイトがコピーされるまで pszDest を null 文字で埋め込み続けません。

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

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

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

文字列型 (String) リテラル文字列 機能
char "string" StringCbCopyNA
TCHAR TEXT("string") StringCbCopyN
Wchar L"string" StringCbCopyNW
 

注意

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

要件

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

関連項目

参照

StringCbCopy

StringCbCopyNEx

StringCchCopyN