sous-routine wcsxfrm

Editer en ligne

Objectif

Transforme des chaînes de caractères larges vers des codes de caractères larges de l'environnement local en cours.

Bibliothèque

Bibliothèque C standard (libc.a)

Syntaxe

#include <string.h>
size_t wcsxfrm ( WcString1,  WcString2,  Number)
wchar_t *WcString1;
const wchar_t *WcString2;
size_t Number;

size_t wcsxfrm_l ( WcString1,
WcString2, Nombre, Environnement local)
wchar_t * WcString1;
const wchar_t * WcString2;
size_t nombre;
locale_t Paramètres régionaux;

Descriptif

Les sous-routines Wcsxfrm et Wcsxfrm _l transforment la chaîne de caractères larges spécifiée par le paramètre WcString2 en une chaîne de codes de caractères larges, en fonction des valeurs de classement des caractères larges dans l'environnement local actuel, comme spécifié par la catégorie LC_COLLATE de l'environnement local en cours ou de l'environnement local représenté par Environnement local , respectivement. Le nombre de codes de caractères spécifiés par le paramètre Numéro est copié dans le tableau indiqué par le paramètre WcString1 . Lorsque deux chaînes de caractères larges transformées sont comparées à l'aide de la sous-routine Wcscmp ou Wcscoll_l , le résultat est le même que celui obtenu par un appel direct au sous-programme Wcscoll ou Wcscoll_l sur les deux chaînes de caractères larges d'origine.

Paramètres

Article Descriptif
WcString1 Pointe vers la chaîne de caractères large de destination.
WcString2 Pointe vers la chaîne de caractères larges source.
Nombre Indique le nombre maximal de codes de caractères larges à placer dans le tableau spécifié par WcString1. Pour déterminer la spécification de taille nécessaire, définissez le paramètre Numéro sur une valeur de 0, de sorte que le paramètre WcString1 devienne un pointeur nul. La valeur de retour plus 1 est la taille nécessaire à la conversion.
Environnement local Indique l'environnement local dans lequel le caractère doit être converti.

Valeurs renvoyées

Si le paramètre WcString1 est un pointeur nul de caractère large, Wcsxfrm et la sous-routine Wcsxfrm_l renvoient le nombre d'éléments de caractère large (à l'exception du caractère de terminaison NULL de caractères larges) requis pour stocker la chaîne de caractères larges transformée. Si le nombre spécifié par le paramètre Numéro est suffisant pour contenir la chaîne transformée dans le paramètre WcString1 , y compris le caractère de terminaison NULL de caractères larges, la valeur de retour est définie sur le nombre réel d'éléments de caractères larges placés dans le paramètre WcString1 , sans inclure le caractère large null. Si la valeur de retour est égale ou supérieure à la valeur spécifiée par le paramètre Numéro , le contenu du tableau désigné par le paramètre WcString1 est indéterminé. Cela se produit lorsque le paramètre de valeur Numéro est trop petit pour contenir l'intégralité de la chaîne transformée. En cas d'erreur, le sous-programme wcsxfrm renvoie le type de données size_t avec la valeur -1 et définit la variable globale errno pour indiquer l'erreur.

Si la chaîne de caractères larges pointée par le paramètre WcString2 contient des codes de caractères larges en dehors du domaine de la séquence de classement définie par l'environnement local en cours, les sous-routines Wcsxfrm et Wcsxfrm_l renvoient une valeur de EINVAL.