FindNLSString

関数

ロケールを考慮して文字列内から部分文字列を検索する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

INT FindNLSString(
    DWORD Locale,
    DWORD dwFindNLSStringFlags,
    LPCWSTR lpStringSource,
    INT cchSource,
    LPCWSTR lpStringValue,
    INT cchValue,
    INT* pcchFound   // optional
);

パラメーター

名前	型	方向	説明
Locale	DWORD	in	ロケールを指定するロケール識別子です。MAKELCID マクロを使用して識別子を作成するか、次の定義済みの値のいずれかを使用できます。 LOCALE_INVARIANT LOCALE_SYSTEM_DEFAULT LOCALE_USER_DEFAULT Windows Vista 以降: 次のカスタムロケール識別子もサポートされています。 LOCALE_CUSTOM_DEFAULT LOCALE_CUSTOM_UI_DEFAULT LOCALE_CUSTOM_UNSPECIFIED
dwFindNLSStringFlags	DWORD	in	検索操作の詳細を指定するフラグです。詳細な定義については、FindNLSStringEx の dwFindNLSStringFlags パラメーターを参照してください。
lpStringSource	LPCWSTR	in	ソース文字列へのポインターです。関数はこの文字列内で、lpStringValue で指定された文字列を検索します。
cchSource	INT	in	lpStringSource で示される文字列の、終端の null 文字を除いた文字数単位のサイズです。このパラメーターに 0、または -1 以外の負の数を指定することはできません。ソース文字列が null 終端されており、関数にサイズを自動的に計算させる場合は -1 を指定します。
lpStringValue	LPCWSTR	in	検索文字列へのポインターです。関数はソース文字列内でこの文字列を検索します。
cchValue	INT	in	lpStringValue で示される文字列の、終端の null 文字を除いた文字数単位のサイズです。このパラメーターに 0、または -1 以外の負の数を指定することはできません。検索文字列が null 終端されており、関数にサイズを自動的に計算させる場合は -1 を指定します。
pcchFound	INT*	outoptional	関数が見つけた文字列の長さを格納するバッファーへのポインターです。詳細については、FindNLSStringEx の pcchFound パラメーターを参照してください。

戻り値の型: INT

公式ドキュメント

識別子で指定したロケールについて、Unicode 文字列(ワイド文字)またはそれに相当する文字列を、別の Unicode 文字列内で検索します。注意バイナリ表現が大きく異なる文字列でも同一として比較されることがあるため、この関数には一定のセキュリティ上の懸念があります。詳細については、Security Considerations: International Features の比較関数に関する説明を参照してください。メモ相互運用性の観点から、アプリケーションでは FindNLSStringEx 関数の使用を推奨します。Microsoft では、新しいロケールについてロケール識別子の代わりにロケール名を使用する方向へ移行しているためです。FindNLSString はカスタムロケールをサポートしていますが、この種のサポートが必要な場合、ほとんどのアプリケーションでは FindNLSStringEx を使用してください。

戻り値

成功した場合、lpStringSource で示されるソース文字列への 0 始まりのインデックスを返します。このインデックスは、pcchFound の値と組み合わせることで、見つかった文字列全体のソース文字列内における正確な位置を示します。戻り値 0 はエラーのないソース文字列へのインデックスであり、一致した文字列がソース文字列のオフセット 0 にあることを意味します。

関数が成功しなかった場合は -1 を返します。拡張エラー情報を取得するには、アプリケーションから GetLastError を呼び出します。これにより、次のいずれかのエラーコードが返される場合があります。

ERROR_INVALID_FLAGS。フラグに指定された値が無効でした。
ERROR_INVALID_PARAMETER。いずれかのパラメーター値が無効でした。
ERROR_SUCCESS。処理は正常に完了しましたが、結果は得られませんでした。

解説(Remarks)

「解説」については FindNLSStringEx を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

INT FindNLSString(
    DWORD Locale,
    DWORD dwFindNLSStringFlags,
    LPCWSTR lpStringSource,
    INT cchSource,
    LPCWSTR lpStringValue,
    INT cchValue,
    INT* pcchFound   // optional
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int FindNLSString(
    uint Locale,   // DWORD
    uint dwFindNLSStringFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpStringSource,   // LPCWSTR
    int cchSource,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] string lpStringValue,   // LPCWSTR
    int cchValue,   // INT
    IntPtr pcchFound   // INT* optional, out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindNLSString(
    Locale As UInteger,   ' DWORD
    dwFindNLSStringFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpStringSource As String,   ' LPCWSTR
    cchSource As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpStringValue As String,   ' LPCWSTR
    cchValue As Integer,   ' INT
    pcchFound As IntPtr   ' INT* optional, out
) As Integer
End Function

' Locale : DWORD
' dwFindNLSStringFlags : DWORD
' lpStringSource : LPCWSTR
' cchSource : INT
' lpStringValue : LPCWSTR
' cchValue : INT
' pcchFound : INT* optional, out
Declare PtrSafe Function FindNLSString Lib "kernel32" ( _
    ByVal Locale As Long, _
    ByVal dwFindNLSStringFlags As Long, _
    ByVal lpStringSource As LongPtr, _
    ByVal cchSource As Long, _
    ByVal lpStringValue As LongPtr, _
    ByVal cchValue As Long, _
    ByVal pcchFound As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindNLSString = ctypes.windll.kernel32.FindNLSString
FindNLSString.restype = ctypes.c_int
FindNLSString.argtypes = [
    wintypes.DWORD,  # Locale : DWORD
    wintypes.DWORD,  # dwFindNLSStringFlags : DWORD
    wintypes.LPCWSTR,  # lpStringSource : LPCWSTR
    ctypes.c_int,  # cchSource : INT
    wintypes.LPCWSTR,  # lpStringValue : LPCWSTR
    ctypes.c_int,  # cchValue : INT
    ctypes.POINTER(ctypes.c_int),  # pcchFound : INT* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FindNLSString = Fiddle::Function.new(
  lib['FindNLSString'],
  [
    -Fiddle::TYPE_INT,  # Locale : DWORD
    -Fiddle::TYPE_INT,  # dwFindNLSStringFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpStringSource : LPCWSTR
    Fiddle::TYPE_INT,  # cchSource : INT
    Fiddle::TYPE_VOIDP,  # lpStringValue : LPCWSTR
    Fiddle::TYPE_INT,  # cchValue : INT
    Fiddle::TYPE_VOIDP,  # pcchFound : INT* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn FindNLSString(
        Locale: u32,  // DWORD
        dwFindNLSStringFlags: u32,  // DWORD
        lpStringSource: *const u16,  // LPCWSTR
        cchSource: i32,  // INT
        lpStringValue: *const u16,  // LPCWSTR
        cchValue: i32,  // INT
        pcchFound: *mut i32  // INT* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int FindNLSString(uint Locale, uint dwFindNLSStringFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpStringSource, int cchSource, [MarshalAs(UnmanagedType.LPWStr)] string lpStringValue, int cchValue, IntPtr pcchFound);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FindNLSString' -Namespace Win32 -PassThru
# $api::FindNLSString(Locale, dwFindNLSStringFlags, lpStringSource, cchSource, lpStringValue, cchValue, pcchFound)

#uselib "KERNEL32.dll"
#func global FindNLSString "FindNLSString" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; FindNLSString Locale, dwFindNLSStringFlags, lpStringSource, cchSource, lpStringValue, cchValue, varptr(pcchFound)   ; 戻り値は stat
; Locale : DWORD -> "sptr"
; dwFindNLSStringFlags : DWORD -> "sptr"
; lpStringSource : LPCWSTR -> "sptr"
; cchSource : INT -> "sptr"
; lpStringValue : LPCWSTR -> "sptr"
; cchValue : INT -> "sptr"
; pcchFound : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global FindNLSString "FindNLSString" int, int, wstr, int, wstr, int, var
; res = FindNLSString(Locale, dwFindNLSStringFlags, lpStringSource, cchSource, lpStringValue, cchValue, pcchFound)
; Locale : DWORD -> "int"
; dwFindNLSStringFlags : DWORD -> "int"
; lpStringSource : LPCWSTR -> "wstr"
; cchSource : INT -> "int"
; lpStringValue : LPCWSTR -> "wstr"
; cchValue : INT -> "int"
; pcchFound : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global FindNLSString "FindNLSString" int, int, wstr, int, wstr, int, sptr
; res = FindNLSString(Locale, dwFindNLSStringFlags, lpStringSource, cchSource, lpStringValue, cchValue, varptr(pcchFound))
; Locale : DWORD -> "int"
; dwFindNLSStringFlags : DWORD -> "int"
; lpStringSource : LPCWSTR -> "wstr"
; cchSource : INT -> "int"
; lpStringValue : LPCWSTR -> "wstr"
; cchValue : INT -> "int"
; pcchFound : INT* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。