Fonction FindNLSString (winnls.h)

Article
03/04/2024

Recherche une chaîne Unicode (caractères larges) ou son équivalent dans une autre chaîne Unicode pour un paramètre régional spécifié par l’identificateur.

Attention Étant donné que les chaînes avec des représentations binaires très différentes peuvent être comparées comme identiques, cette fonction peut soulever certaines préoccupations de sécurité. Pour plus d’informations, consultez la discussion sur les fonctions de comparaison dans Considérations relatives à la sécurité : fonctionnalités internationales.

Note Pour des raisons d’interopérabilité, l’application doit préférer la fonction FindNLSStringEx , car Microsoft migre vers l’utilisation de noms régionaux au lieu d’identificateurs régionaux pour les nouveaux paramètres régionaux. Bien que FindNLSString prenne en charge les paramètres régionaux personnalisés, la plupart des applications doivent utiliser FindNLSStringEx pour ce type de prise en charge.

Syntaxe

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

Paramètres

[in] Locale

Identificateur de paramètres régionaux qui spécifie les paramètres régionaux. Vous pouvez utiliser la macro MAKELCID pour créer un identificateur ou utiliser l’une des valeurs prédéfinies suivantes.

Windows Vista et versions ultérieures : Les identificateurs de paramètres régionaux personnalisés suivants sont également pris en charge.

[in] dwFindNLSStringFlags

Indicateurs spécifiant les détails de l’opération de recherche. Pour obtenir des définitions détaillées, consultez le paramètre dwFindNLSStringFlags de FindNLSStringEx.

[in] lpStringSource

Pointeur vers la chaîne source, dans laquelle la fonction recherche la chaîne spécifiée par lpStringValue.

[in] cchSource

Taille, en caractères à l’exclusion du caractère null de fin, de la chaîne indiquée par lpStringSource. L’application ne peut pas spécifier 0 ou un nombre négatif autre que -1 pour ce paramètre. L’application spécifie -1 si la chaîne source est terminée par null et si la fonction doit calculer automatiquement la taille.

[in] lpStringValue

Pointeur vers la chaîne de recherche, pour laquelle la fonction effectue des recherches dans la chaîne source.

[in] cchValue

Taille, en caractères à l’exclusion du caractère null de fin, de la chaîne indiquée par lpStringValue. L’application ne peut pas spécifier 0 ou un nombre négatif autre que -1 pour ce paramètre. L’application spécifie -1 si la chaîne de recherche est terminée par null et que la fonction doit calculer automatiquement la taille.

[out, optional] pcchFound

Pointeur vers une mémoire tampon contenant la longueur de la chaîne que la fonction recherche. Pour plus d’informations, consultez le paramètre pcchFound de FindNLSStringEx.

Valeur retournée

Retourne un index de base 0 dans la chaîne source indiquée par lpStringSource en cas de réussite. En combinaison avec la valeur dans pcchFound, cet index fournit l’emplacement exact de l’ensemble de la chaîne trouvée dans la chaîne source. Une valeur de retour 0 est un index sans erreur dans la chaîne source, et la chaîne correspondante se trouve dans la chaîne source au décalage 0.

La fonction retourne -1 si elle ne réussit pas. Pour obtenir des informations d’erreur étendues, l’application peut appeler GetLastError, qui peut retourner l’un des codes d’erreur suivants :

ERROR_INVALID_FLAGS. Les valeurs fournies pour les indicateurs n’étaient pas valides.
ERROR_INVALID_PARAMETER. L’une des valeurs de paramètre n’était pas valide.
ERROR_SUCCESS. L’action s’est terminée avec succès, mais n’a produit aucun résultat.

Remarques

Consultez Remarques pour FindNLSStringEx.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winnls.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll