Fungsi CompareStringOrdinal (stringapiset.h)

Artikel
08/26/2023

Membandingkan dua string Unicode dengan menguji kesetaraan biner.

Sintaks

int CompareStringOrdinal(
  [in] _In_NLS_string_(cchCount1)LPCWCH lpString1,
  [in] int                              cchCount1,
  [in] _In_NLS_string_(cchCount2)LPCWCH lpString2,
  [in] int                              cchCount2,
  [in] BOOL                             bIgnoreCase
);

Parameter

[in] lpString1

Arahkan ke string pertama untuk dibandingkan.

[in] cchCount1

Panjang string yang ditunjukkan oleh lpString1. Aplikasi memasok -1 jika string dihentikan null. Dalam hal ini, fungsi menentukan panjang secara otomatis.

[in] lpString2

Arahkan ke string kedua untuk dibandingkan.

[in] cchCount2

Panjang string yang ditunjukkan oleh lpString2. Aplikasi memasok -1 jika string dihentikan null. Dalam hal ini, fungsi menentukan panjang secara otomatis.

[in] bIgnoreCase

TRUE jika fungsinya adalah melakukan perbandingan yang tidak peka huruf besar/kecil, menggunakan informasi tabel huruf besar sistem operasi. Aplikasi mengatur parameter ini ke FALSE jika fungsinya adalah membandingkan string persis seperti yang diteruskan. Perhatikan bahwa 1 adalah satu-satunya nilai numerik yang dapat digunakan untuk menentukan nilai sebenarnya untuk parameter boolean ini yang tidak mengakibatkan kesalahan parameter yang tidak valid. Nilai Boolean untuk parameter ini berfungsi seperti yang diharapkan.

Menampilkan nilai

Mengembalikan salah satu nilai berikut jika berhasil. Untuk mempertahankan konvensi runtime C membandingkan string, nilai 2 dapat dikurangi dari nilai pengembalian bukan nol. Kemudian, arti <0, ==0, dan >0 konsisten dengan runtime C.

CSTR_LESS_THAN. Nilai yang ditunjukkan oleh lpString1 kurang dari nilai yang ditunjukkan oleh lpString2.
CSTR_EQUAL. Nilai yang ditunjukkan oleh lpString1 sama dengan nilai yang ditunjukkan oleh lpString2.
CSTR_GREATER_THAN. Nilai yang ditunjukkan oleh lpString1 lebih besar dari nilai yang ditunjukkan oleh lpString2.

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

ERROR_INVALID_PARAMETER. Salah satu nilai parameter tidak valid.

Keterangan

Fungsi ini menguji kesetaraan biner, bukan kesetaraan linguistik. Untuk informasi tentang penggunaan fungsi untuk pengurutan ordinal, lihat Menangani Pengurutan di Aplikasi Anda.

Aplikasi yang berkaitan dengan kesetaraan linguistik harus menggunakan CompareString, CompareStringEx, lstrcmp, atau lstrcmpi. Untuk informasi selengkapnya tentang pengurutan linguistik, lihat Menangani Pengurutan di Aplikasi Anda

Dimulai dengan Windows 8: CompareStringOrdinal dideklarasikan dalam Stringapiset.h. Sebelum Windows 8, itu dinyatakan di Winnls.h.

Persyaratan


Klien minimum yang didukung	Windows Vista [aplikasi desktop \| Aplikasi UWP]
Server minimum yang didukung	Windows Server 2008 [aplikasi desktop \| Aplikasi UWP]
Target Platform	Windows
Header	stringapiset.h (termasuk Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll