次の方法で共有

StringCbGetsExW 関数 (strsafe.h)

  • [アーティクル]

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

注 この関数はインラインでのみ使用できます。
 
StringCbGetsEx は、宛先文字列の末尾へのポインターと、その文字列で使用されていない残りのバイト数を返すことによって、StringCbGets の機能を追加します。 フラグは、追加の制御のために関数に渡すこともできます。

StringCbGetsEx は、次の関数の代わりに使用されます。

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

構文

STRSAFEAPI StringCbGetsExW(
  [out]           STRSAFE_LPWSTR pszDest,
  [in]            size_t         cbDest,
  [out, optional] STRSAFE_LPWSTR *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags
);

パラメーター

[out] pszDest

型: LPTSTR

入力を受信する宛先バッファー。

[in] cbDest

型: size_t

コピー先バッファーのサイズ (バイト単位)。 関数を成功させるには、この値が sizeof(TCHAR) より大きい必要があります。 許容される最大バイト数は STRSAFE_MAX_CCH * sizeof(TCHAR)です。 cbDest 小さすぎてテキスト全体を保持するには、データが切り捨てられます。

[out, optional] ppszDestEnd

型: LPTSTR*

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

[out, optional] pcbRemaining

型: size_t*

pszDest内の未使用のバイト数 (終端の null 文字に使用されたものも含む)。 pcbRemaining が NULL場合、カウントは保持されず、返されません。

[in] dwFlags

型: DWORD

次の値のうち 1 つ以上。

価値 意味
STRSAFE_FILL_BEHIND_NULL
0x00000200
 関数が成功した場合、dwFlags (0) の下位バイトを使用して、終端の null 文字に続く pszDest 初期化されていない部分を埋めます。
STRSAFE_IGNORE_NULLS
0x00000100
 空 文字列 (TEXT("")) のように NULL 文字列ポインターを扱います。 このフラグは、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 または フェロル を使用して、発生したフェロル を特定します。
STRSAFE_E_INVALID_PARAMETER
 cbDest の値が許容される最大値より大きいか、無効なフラグが渡されました。
STRSAFE_E_INSUFFICIENT_BUFFER
 cbDest の値は 1 以下です。
 

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

備考

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

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

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

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

手記

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

必要条件

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

関連項目

リファレンス

StringCbGets

StringCchGetsEx