次の方法で共有

StringCchCopyW 関数 (strsafe.h)

  • [アーティクル]

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

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

構文

STRSAFEAPI StringCchCopyW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_LPCWSTR pszSrc
);

パラメーター

[out] pszDest

型: LPTSTR

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

[in] cchDest

型: size_t

変換先バッファーのサイズ (文字数)。 この値は、コピーされたソース文字列と終端の null 文字を考慮するために、pszSrc の長さに 1 を加えた長さに等しい必要があります。 使用できる最大文字数は STRSAFE_MAX_CCHです。

[in] pszSrc

型: LPCTSTR

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

戻り値

型: HRESULT

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

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

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

備考

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

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

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

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

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

手記

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

必要条件

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

関連項目

リファレンス

StringCbCopy の

StringCchCopyEx の