Función CompareStringWrapW

[CompareStringWrapW está disponible para su uso en Windows XP. No estará disponible en versiones posteriores. Debe usar CompareStringW en su lugar.]

Compara dos cadenas de caracteres Unicode con una configuración regional especificada.

Nota

CompareStringWrapW es un contenedor para la función CompareStringW . Consulte la página CompareString para obtener más notas de uso.

 

Sintaxis

int CompareStringWrapW(
  _In_ LCID    Locale,
  _In_ DWORD   dwCmpFlags,
  _In_ LPCWSTR lpString1,
  _In_ int     cchCount1,
  _In_ LPCWSTR lpString2,
  _In_ int     cchCount2
);

Parámetros

Configuración regional [in]

Tipo: LCID

Identificador de configuración regional que se usa para la comparación. Este parámetro puede ser uno de los siguientes identificadores de configuración regional predefinidos o un identificador de configuración regional creado por la macro MAKELCID .

LOCALE_SYSTEM_DEFAULT

Configuración regional predeterminada del sistema.

LOCALE_USER_DEFAULT

Configuración regional predeterminada del usuario actual.

dwCmpFlags [in]

Tipo: DWORD

Marcas que indican cómo la función compara las dos cadenas. De forma predeterminada, estas marcas no se establecen. Establezca en cero para obtener el comportamiento predeterminado o en cualquier combinación de los valores siguientes.

NORM_IGNORECASE

Omitir mayúsculas y minúsculas.

NORM_IGNOREKANATYPE

No diferencie entre los caracteres Hiragana y Katakana. Los caracteres Hiragana y Katakana correspondientes se comparan como iguales.

NORM_IGNORENONSPACE

Omitir caracteres sin espaciado.

NORM_IGNORESYMBOLS

Omitir símbolos.

NORM_IGNOREWIDTH

No diferencie entre un carácter de un solo byte y el mismo carácter que un carácter de doble byte.

SORT_STRINGSORT

Trate la puntuación igual que los símbolos.

lpString1 [in]

Tipo: LPCWSTR

Puntero a la primera cadena Unicode que se va a comparar.

cchCount1 [in]

Tipo: int

Número de caracteres de la cadena a la que apunta el parámetro lpString1 . El recuento no incluye el carácter nulo de terminación. Si este parámetro es un valor negativo, se supone que la cadena está terminada en null y la longitud se calcula automáticamente.

lpString2 [in]

Tipo: LPCWSTR

Puntero a la segunda cadena Unicode que se va a comparar.

cchCount2 [in]

Tipo: int

Número de caracteres de la cadena a la que apunta el parámetro lpString2 . El recuento no incluye el carácter nulo de terminación. Si este parámetro es un valor negativo, se supone que la cadena está terminada en null y la longitud se calcula automáticamente.

Valor devuelto

Tipo: int

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError. GetLastError puede devolver uno de los siguientes códigos de error.

• ERROR_INVALID_FLAGS
• ERROR_INVALID_PARAMETER

Si la función se ejecuta correctamente, el valor devuelto es uno de los siguientes valores.

Requisito	Value
CSTR_LESS_THAN	La cadena a la que apunta el parámetro lpString1 es menor en el valor léxico que la cadena a la que apunta el parámetro lpString2 .
CSTR_EQUAL	La cadena a la que apunta lpString1 es igual en el valor léxico a la cadena a la que apunta lpString2.
CSTR_GREATER_THAN	La cadena a la que apunta lpString1 es mayor en el valor léxico que la cadena a la que apunta lpString2.

 

Comentarios

Advertencia de seguridad: El uso incorrecto de esta función puede poner en peligro la seguridad de la aplicación. Las cadenas que no se comparan correctamente pueden producir entradas no válidas. Pruebe las cadenas para asegurarse de que son válidas antes de usarlas y proporcionar controladores de errores. Para obtener más información, vea Consideraciones de seguridad: Características internacionales

El método preferido es usar CompareStringW junto con Microsoft Layer para Unicode (MSLU).

Se debe llamar a CompareStringWrapW directamente desde Shlwapi.dll, mediante ordinal 45.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Encabezado	None
Archivo DLL	Shlwapi.dll (versión 5.0 o posterior)

Consulte también

CompareString