FindNLSString 関数 (winnls.h)
識別子で指定されたロケールの Unicode 文字列 (ワイド文字) またはその同等の Unicode 文字列を別の Unicode 文字列で検索します。
構文
int FindNLSString(
[in] LCID Locale,
[in] DWORD dwFindNLSStringFlags,
[in] LPCWSTR lpStringSource,
[in] int cchSource,
[in] LPCWSTR lpStringValue,
[in] int cchValue,
[out, optional] LPINT pcchFound
);
パラメーター
[in] Locale
ロケール を指定するロケール識別子。 MAKELCID マクロを使用して識別子を作成するか、次のいずれかの定義済み値を使用できます。
Windows Vista 以降: 次のカスタム ロケール識別子もサポートされています。[in] dwFindNLSStringFlags
検索操作の詳細を指定するフラグ。 詳細な定義については、FindNLSStringEx の dwFindNLSStringFlags パラメーターを参照してください。
[in] lpStringSource
lpStringValue で指定された文字列を関数が検索するソース文字列へのポインター。
[in] cchSource
lpStringSource で示される文字列の終端の null 文字を除く文字単位のサイズ。 アプリケーションでは、このパラメーターに 0 または -1 以外の負の数を指定できません。 ソース文字列が null で終了し、関数がサイズを自動的に計算する必要がある場合、アプリケーションは -1 を指定します。
[in] lpStringValue
関数がソース文字列で検索する検索文字列へのポインター。
[in] cchValue
lpStringValue で示される文字列の終端の null 文字を除く文字単位のサイズ。 アプリケーションでは、このパラメーターに 0 または -1 以外の負の数を指定できません。 検索文字列が null で終了し、関数がサイズを自動的に計算する必要がある場合、アプリケーションは -1 を指定します。
[out, optional] pcchFound
関数が検索する文字列の長さを含むバッファーへのポインター。 詳細については、FindNLSStringEx の pcchFound パラメーターを参照してください。
戻り値
成功した場合、 lpStringSource によって示されるソース文字列に 0 から始まるインデックスを返します。 このインデックスは、 pcchFound の値と組み合わせて、ソース文字列内で見つかった文字列全体の正確な場所を提供します。 戻り値 0 はソース文字列へのエラーのないインデックスであり、一致する文字列はオフセット 0 のソース文字列にあります。
成功しなかった場合、関数は -1 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。このエラー コードは、次のいずれかのエラー コードを返すことができます。
- ERROR_INVALID_FLAGS。 フラグに指定された値が無効です。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
- ERROR_SUCCESS。 アクションは正常に完了しましたが、結果は生成されません。
注釈
「FindNLSStringEx の備考」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winnls.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |