__crtLCMapStringW

Mappe une chaîne de caractères à une autre en effectuant une transformation dépendante des paramètres régionaux spécifiés. Cette fonction peut aussi être utilisée pour générer une clé de tri pour la chaîne d’entrée.

Syntaxe

int __crtLCMapStringW(
   LCID    Locale,
   DWORD   dwMapFlags,
   LPCWSTR lpSrcStr,
   int     cchSrc,
   LPWSTR  lpDestStr,
   int     cchDest)

Paramètres

Locale
Identificateur de paramètres régionaux. Les paramètres régionaux fournissent un contexte pour le mappage de chaînes ou la génération de clés de tri. Une application peut utiliser la macro MAKELCID pour créer un identificateur de paramètres régionaux.

dwMapFlags
Type de transformation à utiliser pendant le mappage de chaînes ou la génération de clés de tri.

lpSrcStr
Pointeur vers une chaîne source que la fonction mappe ou utilise pour la génération de clés de tri. Ce paramètre est censé être une chaîne de type Unicode.

cchSrc
Taille en caractères de la chaîne pointée par le paramètre lpSrcStr . Ce nombre peut ou non inclure le terminateur null.

La valeur -1 de cchSrc indique que la chaîne pointée par lpSrcStr se termine par un caractère Null. Dans ce cas, et cette fonction est utilisée dans son mode de mappage de chaînes, la fonction calcule la longueur de la chaîne elle-même et termine la chaîne mappée stockée dans *lpDestStr.

lpDestStr
Pointeur long désignant une mémoire tampon dans laquelle la fonction stocke la chaîne mappée ou la clé de tri.

cchDest
Taille en caractères de la mémoire tampon pointée par lpDestStr.

Valeur retournée

Si la valeur de cchDest est différente de zéro, le nombre de caractères (ou d’octets si LCMAP_SORTKEY est spécifié) écrits dans la mémoire tampon indique que l’opération a réussi. Ce nombre inclut l’espace destiné à accueillir un terminateur null.

Si la valeur de cchDest est égale à zéro, la taille de la mémoire tampon en caractères (ou en octets si LCMAP_SORTKEY est spécifié) nécessaire pour recevoir la chaîne traduite ou la clé de tri indique que l’opération a réussi. Cette taille inclut de l’espace destiné à accueillir un terminateur null.

La valeur zéro indique l’échec de l’opération. Pour obtenir des informations plus complètes sur les erreurs, appelez la fonction GetLastError .

Notes

Si cchSrc est supérieure à zéro et que lpSrcStr est une chaîne qui se termine par un caractère null, __crtLCMapStringW affecte à cchSrc la longueur de la chaîne. __crtLCMapStringW appelle ensuite la version de chaîne étendue (Unicode) de la fonction LCMapString avec les paramètres spécifiés. Pour plus d’informations sur les paramètres et la valeur de retour de cette fonction, consultez le LCMapStringfichier .

Spécifications

Routine	En-tête requis
__crtLCMapStringW	<awint.h>