StringCbCopyNExA 関数 (strsafe.h)
指定したバイト数を 1 つの文字列から別の文字列にコピーします。 コピー先バッファーのサイズは、このバッファーの末尾を越えて書き込まれないように、関数に提供されます。
StringCbCopyNEx は、宛先文字列 の末尾へのポインターと、その文字列で使用されていない残りのバイト数を返すことによって、StringCbCopyN の機能を追加します。 フラグは、追加の制御のために関数に渡すこともできます。
StringCbCopyNEx は、次の関数の代わりに使用されます。
構文
STRSAFEAPI StringCbCopyNExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToCopy,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
パラメーター
[out] pszDest
型: LPTSTR
コピーされた文字列を受け取る宛先バッファー。
[in] cbDest
型: size_t
pszDestSTRSAFE_MAX_CCH * sizeof(TCHAR)です。
[in] pszSrc
型: LPCTSTR
ソース文字列。 この文字列は null で終わる必要があります。
[in] cbToCopy
型: size_t
[out, optional] ppszDestEnd
型: LPTSTR*
pszDestの末尾へのポインター
[out, optional] pcbRemaining
型: size_t*
pszDest内の未使用のバイト数 (終端の null 文字に使用されたものも含む)。
[in] dwFlags
型: DWORD
次の値のうち 1 つ以上。
戻り値
型: HRESULT
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、
| リターン コード | 形容 |
|---|---|
|
ソース データが存在し、切り捨てなしで完全にコピーされ、結果のコピー先バッファーは null で終了します。 |
|
pszDest |
|
バッファー領域が不足しているため、コピー操作に失敗しました。 dwFlagsの値によっては、コピー先バッファーに、意図した結果の切り捨てられた null で終わるバージョンが含まれている場合があります。 切り捨てが許容される状況では、これは必ずしも失敗状態と見なされない場合があります。 |
この関数は、置き換える関数とは異なり、HRESULT 値を返します。
備考
StringCbCopyNEx では、コード内で適切なバッファー処理を行うための追加処理が提供されます。 バッファーの処理が不適切なのは、バッファー オーバーランを伴う多くのセキュリティの問題に関係しています。 StringCbCopyNEx 常に null 終了し、操作中にソース文字列の内容が変更された場合でも、有効な宛先バッファーをオーバーフローすることはありません。
このルーチンは、strncpyの代わりとして使用されますが、動作に違いがあります。
pszSrc が指す文字列と pszDest
pszSrc
StringCbCopyNEx は、その汎用形式またはより具体的な形式で使用できます。 次の表に示すように、文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。
| 文字列データ型 | 文字列リテラル | 機能 |
|---|---|---|
| char を |
"string" | StringCbCopyNExA の |
| TCHAR の |
TEXT("string") | StringCbCopyNEx の |
| WCHAR の |
L"string" | StringCbCopyNExW の |
手記
strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCbCopyNEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows XP と SP2 [デスクトップ アプリ |UWP アプリ] |
| サポートされる最小サーバー | Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ] |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | strsafe.h |
関連項目
リファレンス
StringCbCopyN の