StringCchGetsA 関数 (strsafe.h)

  • [アーティクル]

改行文字 ('\n') まで、stdin から 1 行のテキストを取得します。 テキスト行がコピー先バッファーにコピーされ、改行文字が null 文字に置き換えられます。 コピー先バッファーのサイズは、このバッファーの末尾を超えて書き込まれないようにするために、関数に提供されます。

メモ この関数はインラインでのみ使用できます。
 
StringCchGets は、次の関数に代わる関数です。StringCchGets は fget の代わりではなく、改行文字を終端の null 文字に置き換えるものではありません。

構文

STRSAFEAPI StringCchGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cchDest
);

パラメーター

[out] pszDest

種類: LPTSTR

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

[in] cchDest

種類: size_t

変換先バッファーのサイズ (文字数)。 関数を成功させるには、この値を 2 以上にする必要があります。 許容される最大文字数 (終端の null 文字を含む) は STRSAFE_MAX_CCH。 cchDest が小さすぎてテキスト全体が保持されない場合、データは切り捨てられます。

戻り値

型: HRESULT

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

リターン コード 説明
S_OK
 文字は stdin から読み取られ、 pszDest でバッファーにコピーされ、バッファーは null で終了しました。
STRSAFE_E_END_OF_FILE
 エラーまたはファイルの終了条件を示します。 feof または ferror を使用して、どれが発生したかを判断します。
STRSAFE_E_INVALID_PARAMETER
 cchDest の値が、許容される最大値を超えています。
STRSAFE_E_INSUFFICIENT_BUFFER
 cchDest の値は 1 以下です。
 

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

解説

StringCchGets は、 コード内で適切なバッファー処理を行うための追加の処理を提供します。 バッファーの処理が不十分な場合は、バッファー オーバーランを伴う多くのセキュリティの問題に関係します。 StringCchGets は 、常に 0 以外の長さの宛先バッファーを null で終了します。

pszDest の値を NULL にすることはできません。 null 文字列ポインター値の処理が必要な場合は、「 StringCchGetsEx 」を参照してください。

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

文字列型 (String) リテラル文字列 機能
char "string" StringCchGetsA
TCHAR TEXT("string") StringCchGets
Wchar L"string" StringCchGetsW
 

注意

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

要件

   
サポートされている最小のクライアント SP2 を使用した Windows XP [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー WINDOWS Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム Windows
ヘッダー strsafe.h

関連項目

参照

StringCbGets

StringCchGetsEx