次の方法で共有

StringCchCopyNA 関数 (strsafe.h)

  • [アーティクル]

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

StringCchCopyN は、次の関数の代わりに使用されます。

構文

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cchToCopy
);

パラメーター

[out] pszDest

型: LPTSTR

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

[in] cchDest

型: size_t

pszDestのサイズ (文字単位)。 この値は、コピーした文字 (pszSrc の長さ、または cchSrcの値のいずれか小さい方) に 1 を加えて、終端の null 文字を考慮するのに十分な大きさにする必要があります。 使用できる最大文字数は STRSAFE_MAX_CCHです。

[in] pszSrc

型: LPCTSTR

ソース文字列。 この文字列は、cchSrc 文字または null ターミネータ 読み取り可能である必要があります。どちらか早い方です。

[in] cchToCopy

型: size_t

pszSrc から pszDestコピーする最大文字数。

戻り値

型: HRESULT

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

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

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

備考

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

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

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

pszSrc も pszDest も NULLしないでください。 null 文字列ポインター値 処理する必要がある場合は、StringCchCopyNEx を参照してください。

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

文字列データ型 文字列リテラル 機能
char を する "string" StringCchCopyNA の
TCHAR の TEXT("string") StringCchCopyN の
WCHAR の L"string" StringCchCopyNW
 

手記

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

必要条件

要件 価値
サポートされる最小クライアント Windows XP と SP2 [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー strsafe.h

関連項目

リファレンス

StringCbCopyN の

StringCchCopy

StringCchCopyNEx