次の方法で共有

StringCchLengthW 関数 (strsafe.h)

  • [アーティクル]

文字列が指定した長さを超えるかどうかを文字数で指定します。

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

構文

STRSAFEAPI StringCchLengthW(
  [in]  STRSAFE_PCNZWCH psz,
  [in]  size_t          cchMax,
  [out] size_t          *pcchLength
);

パラメーター

[in] psz

型: LPCTSTR

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

[in] cchMax

型: size_t

pszで許容される最大文字数 (終端の null 文字を含む)。 この値は STRSAFE_MAX_CCHを超えることはできません。

[out] pcchLength

型: size_t*

psz内の文字数 。終端の null 文字は含まれません。 この値は、pcch が NULL されず、関数が成功した場合にのみ有効です。

戻り値

型: HRESULT

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

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

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

備考

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

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

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

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

手記

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

必要条件

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

関連項目

StringCbLength