次の方法で共有

StringCchGetsW 関数 (strsafe.h)

  • [アーティクル]

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

注 この関数はインラインでのみ使用できます。
 
StringCchGets は、次の関数の代わりに使用されます。 StringCchGets は、改行文字を終端の null 文字に置き換える fgetsの代わりではありません。

構文

STRSAFEAPI StringCchGetsW(
  [out] STRSAFE_LPWSTR 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 または フェロル を使用して、発生したフェロル を特定します。
STRSAFE_E_INVALID_PARAMETER
 cchDest の値が、許容される最大値を超えています。
STRSAFE_E_INSUFFICIENT_BUFFER
 cchDest の値は 1 以下です。
 

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

備考

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

pszDest の値 NULLしないでください。 null 文字列ポインター値 処理する必要がある場合は、StringCchGetsEx を参照してください。

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

文字列データ型 文字列リテラル 機能
char を する "string" StringCchGetsA
TCHAR の TEXT("string") StringCchGets
WCHAR の L"string" StringCchGetsW
 

手記

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

必要条件

要件 価値
サポートされる最小クライアント Windows XP と SP2 [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2003 SP1 [デスクトップ アプリ |UWP アプリ]
ターゲット プラットフォーム の ウィンドウズ
ヘッダー strsafe.h

関連項目

リファレンス

StringCbGets

StringCchGetsEx