次の方法で共有


StringCchGetsExA 関数 (strsafe.h)

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

メモ この関数はインラインでのみ使用できます。
 
StringCchGetsEx は 、文字列の末尾へのポインターと、その文字列で使用されていない文字数を返すことによって 、StringCchGets の機能を追加します。 フラグは、追加の制御のために関数に渡すこともできます。

StringCchGetsEx は、次の関数に代わる関数です。

StringCchGetsExfgets に代わるものではありません。改行文字を終端の null 文字に置き換えるものではありません。

構文

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

パラメーター

[out] pszDest

種類: LPTSTR

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

[in] cchDest

種類: size_t

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

[out, optional] ppszDestEnd

種類: LPTSTR*

pszDest の末尾へのポインターのアドレス。 ppszDestEndNULL 以外で、データがコピー先バッファーにコピーされる場合、これは文字列の末尾にある終端の null 文字を指します。

[out, optional] pcchRemaining

種類: size_t*

pszDest の未使用文字の数 (終端の null 文字を含む)。 pcchRemainingNULL の場合、カウントは保持されず、返されません。

[in] dwFlags

型: DWORD

次の値のうち 1 つ以上。

意味
STRSAFE_FILL_BEHIND_NULL
0x00000200
関数が成功した場合、 dwFlags (0) の下位バイトを使用して、終端の null 文字の後に pszDest の初期化されていない部分を埋めます。
STRSAFE_IGNORE_NULLS
0x00000100
NULL 文字列ポインターを空の文字列 (TEXT("")) のように扱います。 このフラグは、 lstrcpy などの関数をエミュレートする場合に便利です。
STRSAFE_FILL_ON_FAILURE
0x00000400
関数が失敗した場合、 dwFlags (0) の下位バイトを使用して pszDest バッファー全体を埋め、バッファーは null で終了します。 STRSAFE_E_INSUFFICIENT_BUFFERエラーが発生した場合、返された切り捨てられた文字列は上書きされます。
STRSAFE_NULL_ON_FAILURE
0x00000800
関数が失敗した場合、 pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFERエラーが発生した場合は、切り捨てられた文字列が上書きされます。
STRSAFE_NO_TRUNCATION
0x00001000
STRSAFE_NULL_ON_FAILUREの場合と同様に、関数が失敗した場合、 pszDest は空の文字列 (TEXT("")) に設定されます。 STRSAFE_E_INSUFFICIENT_BUFFERエラーが発生した場合は、切り捨てられた文字列が上書きされます。

戻り値

型: 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 値を返します。

注釈

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

STRSAFE_IGNORE_NULLS フラグを指定しない限り、pszDest の値は NULL にしないでください。 ただし、 NULL 値が無視されても、領域が不足しているためにエラーが返される可能性があります。

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

文字列型 (String) リテラル文字列 機能
char "string" StringCchGetsExA
TCHAR TEXT("string") StringCchGetsEx
Wchar L"string" StringCchGetsExW
 

注意

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

要件

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

関連項目

参照

StringCbGetsEx

StringCchGets