CompareStringWrapW fonction)

[CompareStringWrapW peut être utilisé dans Windows XP. Elle ne sera pas disponible dans les versions ultérieures. Vous devez utiliser CompareStringW à la place.]

Compare deux chaînes de caractères Unicode à l’aide des paramètres régionaux spécifiés.

Notes

CompareStringWrapW est un wrapper pour la fonction CompareStringW . Pour plus d’informations sur les remarques d’utilisation, consultez la page CompareString .

Syntaxe

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

Paramètres

Paramètres régionaux [ dans]

Type : LCID

Identificateur de paramètres régionaux utilisé pour la comparaison. Ce paramètre peut être l’un des identificateurs de paramètres régionaux prédéfinis suivants ou un identificateur de paramètres régionaux créé par la macro MAKELCID .

paramètres régionaux _ _ par défaut du système

Paramètres régionaux par défaut du système.

paramètres régionaux _ par défaut de l’utilisateur _

Paramètres régionaux par défaut de l’utilisateur actuel.

dwCmpFlags [ dans]

Type : DWORD

Indicateurs qui indiquent comment la fonction compare les deux chaînes. Par défaut, ces indicateurs ne sont pas définis. Affectez la valeur zéro pour accéder au comportement par défaut ou à n’importe quelle combinaison des valeurs suivantes.

_IGNORECASE normal

Ignorer la casse.

_IGNOREKANATYPE normale

Ne faites pas la distinction entre les caractères Hiragana et Katakana. Les caractères Hiragana et Katakana correspondants sont considérés comme égaux.

_IGNORENONSPACE normale

Ignorer les caractères sans espace.

_IGNORESYMBOLS normale

Ignorer les symboles.

_IGNOREWIDTH normale

Ne faites pas la distinction entre un caractère codé sur un octet et le même caractère qu’un caractère codé sur deux octets.

TRIER _ STRINGSORT

Traitez la ponctuation de la même façon que les symboles.

lpString1 [ dans]

Type : LPCWSTR

Pointeur vers la première chaîne Unicode à comparer.

cchCount1 [ dans]

Type : int

Nombre de caractères dans la chaîne vers laquelle pointe le paramètre lpString1 . Le nombre n’inclut pas le caractère null de fin. Si ce paramètre est une valeur négative, il est supposé que la chaîne se termine par un caractère null et que la longueur est calculée automatiquement.

lpString2 [ dans]

Type : LPCWSTR

Pointeur vers la deuxième chaîne Unicode à comparer.

cchCount2 [ dans]

Type : int

Nombre de caractères dans la chaîne vers laquelle pointe le paramètre lpString2 . Le nombre n’inclut pas le caractère null de fin. Si ce paramètre est une valeur négative, il est supposé que la chaîne se termine par un caractère null et que la longueur est calculée automatiquement.

Valeur retournée

Type : int

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. GetLastError peut retourner l’un des codes d’erreur suivants.

  • indicateurs d’erreur _ non valide _
  • paramètre d’erreur _ non valide _

Si la fonction est réussie, la valeur de retour est l’une des valeurs suivantes.

Condition requise Valeur
CSTR _ inférieur _ à La chaîne vers laquelle pointe le paramètre lpString1 est inférieure à la valeur lexicale par rapport à la chaîne vers laquelle pointe le paramètre lpString2 .
CSTR _ égal La chaîne vers laquelle pointe lpString1 est égale à la valeur lexicale à la chaîne désignée par lpString2.
CSTR _ supérieur _ à La chaîne pointée par lpString1 est plus grande dans la valeur lexicale que la chaîne vers laquelle pointe lpString2

Remarques

Avertissement de sécurité : L’utilisation incorrecte de cette fonction peut compromettre la sécurité de votre application. Les chaînes qui ne sont pas comparées correctement peuvent produire une entrée non valide. Testez les chaînes pour vous assurer qu’elles sont valides avant de les utiliser et fournissez des gestionnaires d’erreurs. Pour plus d’informations, consultez Considérations sur la sécurité : fonctionnalités internationales

La méthode recommandée consiste à utiliser CompareStringW conjointement avec la couche Microsoft pour Unicode (MSLU).

CompareStringWrapW doit être appelé directement à partir de Shlwapi.dll, à l’aide de l’ordinal 45.

Configuration requise

Condition requise Valeur
Client minimal pris en charge
Windows 2000 Professional, Windows XP [ desktop apps uniquement]
Serveur minimal pris en charge
Windows Serveur 2003 [ applications de bureau uniquement]
En-tête
Aucun
DLL
Shlwapi.dll (version 5,0 ou ultérieure)

Voir aussi

CompareString