Función CompareStringOrdinal (stringapiset.h)

Artículo
03/08/2023

Compara dos cadenas Unicode para probar la equivalencia binaria.

Sintaxis

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
);

Parámetros

[in] lpString1

Puntero a la primera cadena que se va a comparar.

[in] cchCount1

Longitud de la cadena indicada por lpString1. La aplicación proporciona -1 si la cadena termina en null. En este caso, la función determina la longitud automáticamente.

[in] lpString2

Puntero a la segunda cadena que se va a comparar.

[in] cchCount2

Longitud de la cadena indicada por lpString2. La aplicación proporciona -1 si la cadena termina en null. En este caso, la función determina la longitud automáticamente.

[in] bIgnoreCase

TRUE si la función va a realizar una comparación sin distinción entre mayúsculas y minúsculas, mediante la información de la tabla mayúscula del sistema operativo. La aplicación establece este parámetro en FALSE si la función es comparar las cadenas exactamente como se pasan. Tenga en cuenta que 1 es el único valor numérico que se puede usar para especificar un valor true para este parámetro booleano que no produce un error de parámetro no válido. Los valores booleanos de este parámetro funcionan según lo previsto.

Valor devuelto

Devuelve uno de los valores siguientes si se ejecuta correctamente. Para mantener la convención de tiempo de ejecución de C de comparar cadenas, el valor 2 se puede restar de un valor devuelto distinto de cero. A continuación, el significado de <0, ==0 y >0 es coherente con el tiempo de ejecución de C.

CSTR_LESS_THAN. El valor indicado por lpString1 es menor que el valor indicado por lpString2.
CSTR_EQUAL. El valor indicado por lpString1 es igual al valor indicado por lpString2.
CSTR_GREATER_THAN. El valor indicado por lpString1 es mayor que el valor indicado por lpString2.

La función devuelve 0 si no se realiza correctamente. Para obtener información de error extendida, la aplicación puede llamar a GetLastError, que puede devolver uno de los siguientes códigos de error:

ERROR_INVALID_PARAMETER. Cualquiera de los valores de parámetro no era válido.

Comentarios

Esta función comprueba la igualdad binaria, no la igualdad lingüística. Para obtener información sobre el uso de la función para la ordenación ordinal, vea Control de la ordenación en sus aplicaciones.

Las aplicaciones relacionadas con la igualdad lingüística deben usar CompareString, CompareStringEx, lstrcmp o lstrcmpi. Para obtener más información sobre la ordenación lingüística, consulte Control de la ordenación en las aplicaciones.

A partir de Windows 8: CompareStringOrdinal se declara en Stringapiset.h. Antes de Windows 8, se declaró en Winnls.h.

Requisitos


Cliente mínimo compatible	Windows Vista [aplicaciones de escritorio \| aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 [aplicaciones de escritorio \| aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	stringapiset.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll