Fungsi FindNLSString (winnls.h)

Artikel
03/04/2024

Menemukan string Unicode (karakter lebar) atau yang setara dalam string Unicode lain untuk lokal yang ditentukan oleh pengidentifikasi.

Hati Karena string dengan representasi biner yang sangat berbeda dapat dibandingkan sebagai identik, fungsi ini dapat meningkatkan masalah keamanan tertentu. Untuk informasi selengkapnya, lihat diskusi fungsi perbandingan dalam Pertimbangan Keamanan: Fitur Internasional.

Catatan Untuk alasan interoperabilitas, aplikasi harus lebih memilih fungsi FindNLSStringEx karena Microsoft bermigrasi ke penggunaan nama lokal alih-alih pengidentifikasi lokal untuk lokal baru. Meskipun FindNLSString mendukung lokal kustom, sebagian besar aplikasi harus menggunakan FindNLSStringEx untuk jenis dukungan ini.

Sintaks

int FindNLSString(
  [in]            LCID    Locale,
  [in]            DWORD   dwFindNLSStringFlags,
  [in]            LPCWSTR lpStringSource,
  [in]            int     cchSource,
  [in]            LPCWSTR lpStringValue,
  [in]            int     cchValue,
  [out, optional] LPINT   pcchFound
);

Parameter

[in] Locale

Pengidentifikasi lokal yang menentukan lokal. Anda bisa menggunakan makro MAKELCID untuk membuat pengidentifikasi atau menggunakan salah satu nilai yang telah ditentukan sebelumnya berikut ini.

Windows Vista dan yang lebih baru: Pengidentifikasi lokal kustom berikut ini juga didukung.

[in] dwFindNLSStringFlags

Bendera yang menentukan detail operasi temukan. Untuk definisi terperinci, lihat parameter dwFindNLSStringFlags dari FindNLSStringEx.

[in] lpStringSource

Penunjuk ke string sumber, di mana fungsi mencari string yang ditentukan oleh lpStringValue.

[in] cchSource

Ukuran, dalam karakter tidak termasuk karakter null yang mengakhiri, dari string yang ditunjukkan oleh lpStringSource. Aplikasi tidak dapat menentukan 0 atau angka negatif selain -1 untuk parameter ini. Aplikasi menentukan -1 jika string sumber dihentikan null dan fungsi harus menghitung ukuran secara otomatis.

[in] lpStringValue

Arahkan ke string pencarian, yang fungsinya dicari dalam string sumber.

[in] cchValue

Ukuran, dalam karakter tidak termasuk karakter null yang mengakhiri, dari string yang ditunjukkan oleh lpStringValue. Aplikasi tidak dapat menentukan 0 atau angka negatif selain -1 untuk parameter ini. Aplikasi menentukan -1 jika string pencarian dihentikan null dan fungsi harus menghitung ukuran secara otomatis.

[out, optional] pcchFound

Penunjuk ke buffer yang berisi panjang string yang ditemukan fungsi. Untuk detailnya, lihat parameter pcchFound dari FindNLSStringEx.

Nilai kembali

Mengembalikan indeks berbasis 0 ke dalam string sumber yang ditunjukkan oleh lpStringSource jika berhasil. Dalam kombinasi dengan nilai di pcchFound, indeks ini menyediakan lokasi yang tepat dari seluruh string yang ditemukan dalam string sumber. Nilai pengembalian 0 adalah indeks bebas kesalahan ke dalam string sumber, dan string yang cocok berada dalam string sumber pada offset 0.

Fungsi mengembalikan -1 jika tidak berhasil. Untuk mendapatkan informasi kesalahan yang diperluas, aplikasi dapat memanggil GetLastError, yang dapat mengembalikan salah satu kode kesalahan berikut:

ERROR_INVALID_FLAGS. Nilai yang diberikan untuk bendera tidak valid.
ERROR_INVALID_PARAMETER. Salah satu nilai parameter tidak valid.
ERROR_SUCCESS. Tindakan berhasil diselesaikan tetapi tidak menghasilkan hasil.

Keterangan

Lihat Keterangan untuk FindNLSStringEx.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	winnls.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll