次の方法で共有

StringCbLengthA 関数 (strsafe.h)

  • [アーティクル]

文字列が指定した長さを超えるかどうかをバイト単位で判断します。

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

構文

STRSAFEAPI StringCbLengthA(
  [in]  STRSAFE_PCNZCH psz,
  [in]  size_t         cbMax,
  [out] size_t         *pcbLength
);

パラメーター

[in] psz

型: LPCTSTR

長さがチェックされる文字列。

[in] cbMax

型: size_t

pszで許容される最大バイト数 (終端の null 文字に使用されるものも含む)。 この値は STRSAFE_MAX_CCH * sizeof(TCHAR)を超えることはできません。

[out] pcbLength

型: size_t*

psz内のバイト数 (終端の null 文字に使用されるものを除く)。 この値は、pcb が NULL されず、関数が成功した場合にのみ有効です。

戻り値

型: HRESULT

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

リターン コード 形容
S_OK
 psz の文字列が NULLされず、文字列の長さ (終端の null 文字を含む) が cbMax 文字 以下です。
STRSAFE_E_INVALID_PARAMETER
 psz の値が NULL、cbMax が より大きい 、または psz が cbMaxより長くなっています。
 

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

備考

置き換える関数と比較して、StringCbLength は、コード内で適切なバッファー処理を行うための追加ツールです。 バッファーの処理が不適切なのは、バッファー オーバーランを伴う多くのセキュリティの問題に関係しています。

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

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

UnalignedStringCbLength はこの関数のエイリアスです。

手記

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

必要条件

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

関連項目

StringCchLength