StringCbGetsA 関数 (strsafe.h)
改行文字 ('\n') まで、stdin から 1 行のテキストを取得します。 テキスト行がコピー先バッファーにコピーされ、改行文字が null 文字に置き換えられます。 コピー先バッファーのサイズは、このバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。
構文
STRSAFEAPI StringCbGetsA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest
);
パラメーター
[out] pszDest
種類: LPTSTR
入力を受け取る宛先バッファー。
[in] cbDest
種類: size_t
コピー先バッファーのサイズ (バイト単位)。 関数を成功させるには、この値を より sizeof(TCHAR)
大きくする必要があります。 許容される最大バイト数は です STRSAFE_MAX_CCH * sizeof(TCHAR)
。 cbDest が小さすぎてテキスト全体が保持されない場合、データは切り捨てられます。
戻り値
型: HRESULT
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、 SUCCEEDED マクロと FAILED マクロを使用することを強くお勧めします。
リターン コード | 説明 |
---|---|
|
データは stdin から読み取られ、 pszDest でバッファーにコピーされ、バッファーは null で終了しました。 |
|
エラーまたはファイルの終了条件を示します。 feof または ferror を使用して、どれが発生したかを判断します。 |
|
cbDest の値が、許容される最大値を超えています。 |
|
cbDest の値は 以下ですsizeof(TCHAR) 。
|
この関数は、置き換える関数とは異なり、 HRESULT 値を返します。
解説
StringCbGets は、 コード内で適切なバッファー処理を行うための追加の処理を提供します。 バッファーの処理が不十分な場合は、バッファー オーバーランを伴う多くのセキュリティの問題に関係します。 StringCbGets は 、常に 0 以外の長さの宛先バッファーを null で終了します。
pszDest の値を NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCbGetsEx 」を参照してください。
StringCbGets は、一般的な形式で使用することも、より具体的な形式で使用することもできます。 次の表に示すように、文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。
文字列型 (String) | リテラル文字列 | 機能 |
---|---|---|
char | "string" | StringCbGetsA |
TCHAR | TEXT("string") | StringCbGets |
Wchar | L"string" | StringCbGetsW |
注意
strsafe.h ヘッダーは、StringCbGets をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
サポートされている最小のクライアント | SP2 を使用した Windows XP [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | WINDOWS Server 2003 SP1 [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | strsafe.h |
関連項目
参照