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
この関数は、次のいずれかの値を返すことができます。 この関数の戻り値をテストするには、
リターン コード | 形容 |
---|---|
|
データは stdin から読み取られ、pszDest |
|
エラーまたはファイルの終了条件を示します。 |
|
cbDest |
|
cbDest の値 |
この関数は、置き換える関数とは異なり、HRESULT 値を返します。
備考
StringCbGets は、コード内で適切なバッファー処理のための追加処理を提供します。 バッファーの処理が不適切なのは、バッファー オーバーランを伴う多くのセキュリティの問題に関係しています。 StringCbGets は、常に 0 以外の長さの宛先バッファーを null で終了します。
pszDest の値
StringCbGets は、その一般的な形式またはより具体的な形式で使用できます。 次の表に示すように、文字列のデータ型によって、使用する必要があるこの関数の形式が決まります。
文字列データ型 | 文字列リテラル | 機能 |
---|---|---|
char を |
"string" | StringCbGetsA の |
TCHAR の |
TEXT("string") | StringCbGets |
WCHAR の |
L"string" | StringCbGetsW |
手記
strsafe.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして StringCbGets を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows XP と SP2 [デスクトップ アプリ |UWP アプリ] |
サポートされる最小サーバー | Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | strsafe.h |
関連項目
リファレンス
StringCbGetsEx の