MBSTOWCS(3)

NOM
mbstowcs - Convertir une chaîne de caractères multioctets en une chaîne de caractères larges

SYNOPSIS
#include <stdlib.h>

size_t mbstowcs(wchar_t *dest, const char *src, size_t n);

DESCRIPTION
Si dest n'est pas un pointeur NULL, la fonction mbstowcs() convertit la chaîne multioctet src en chaîne de caractères larges dest. Elle écrira au plus n caractères larges dans dest. L'état de conversion est initialisé. La conversion peut s'arrêter pour l'une des trois raisons suivantes :

1.  Une séquence multioctet incorrecte a été rencontrée. Dans ce cas, elle renvoie (size_t) -1.

2.  n caractères larges non nuls ont été stockés dans dest. Dans ce cas, le nombre de caractères écrits dans dest est renvoyé, mais l'état de décalage en ce point est perdu.

3.  La chaîne multioctet a été complètement convertie, y compris le caractère nul final (« \0 »). Dans ce cas, le nombre de caractères larges écrits dans dest, sans compter le caractère nul final, est renvoyé.

Le programmeur doit s'assurer qu'il y a assez de place pour au moins n caractères larges dans dest.

Si dest est NULL, n est ignoré, et la conversion se présente comme au-dessus, excepté que les caractères larges ne sont pas écrits en mémoire et qu'aucune limite de longueur n'existe.

Afin d'éviter la situation numéro 2 ci-dessus, le programmeur doit s'assurer que n est supérieur ou égal a mbstowcs(NULL,src,0)+1.

VALEUR RENVOYÉE
La fonction mbstowcs() renvoie le nombre de caractères larges qui constituent la partie convertie de la chaîne, sans compter le caractère nul final. Si une séquence multioctet incorrecte est rencontrée, elle renvoie (size_t) -1.

CONFORMITÉ
C99.

NOTES
Le comportement de mbstowcs() dépend de la catégorie LC_CTYPE de la localisation en cours.

La fonction mbsrtowcs(3) fournit une meilleure interface pour la même fonctionnalité.

EXEMPLE
Le programme ci-dessous illustre l’utilisation de mbstowcs(), ainsi que de certaines fonctions de classification pour les caractères larges. Voici un exemple de son exécution.
$ ./t_mbstowcs de_DE.UTF-8 Grüße!
Taille de la chaîne source (sans le caractère final) :
    8 octets
    6 caractères multioctets
La chaîne de caractères larges est : Grüße! (6 caractères)
    G alpha majuscule
    r alpha minuscule
    ü alpha minuscule
    ß alpha minuscule
    e alpha minuscule
    ! !alpha

  Source du programme
#include <locale.h>
#include <wchar.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
int
main(int argc, char *argv[])
{
    size_t mbslen;      /* Nombre de caractères multioctets dans
                           la source */
    wchar_t *wcs;       /* Pointeur vers la chaîne convertie de
                           caractères larges */
    wchar_t *wp;
    if (argc < 3) {
        fprintf(stderr, "Utilisation : %s <locale> <chaîne>\n", argv[0]);
        exit(EXIT_FAILURE);
    }
    /* Appliquer les paramètres régionaux indiqués */
    if (setlocale(LC_ALL, argv[1]) == NULL) {
        perror("setlocale");
        exit(EXIT_FAILURE);
    }
    /* Calculer la taille nécessaire pour stocker argv[2] convertie en
       chaîne de caractères larges */
    mbslen = mbstowcs(NULL, argv[2], 0);
    if (mbslen == (size_t) -1) {
        perror("mbstowcs");
        exit(EXIT_FAILURE);
    }
    /* Décrire la chaîne source à l’utilisateur */
    printf("Taille de la chaîne source (sans le caractère final) :\n");
    printf("    %zu octets\n", strlen(argv[2]));
    printf("    %zu caractères multioctet\n\n", mbslen);
    /* Allouer une chaîne de caractères larges de la taille voulue.
       Ajouter 1 pour accepter le caractère nul final large (L'\0'). */
    wcs = calloc(mbslen + 1, sizeof(wchar_t));
    if (wcs == NULL) {
        perror("calloc");
        exit(EXIT_FAILURE);
    }
    /* Convertir la chaîne de caractères multioctets de argv[2]
       en une chaîne de caractères larges */
    if (mbstowcs(wcs, argv[2], mbslen + 1) == (size_t) -1) {
        perror("mbstowcs");
        exit(EXIT_FAILURE);
    }
    printf("La chaîne de caractères larges est : %ls (%zu caractères)\n",
            wcs, mbslen);
    /* Inspecter un peu les classes des caractères dans la chaîne
       de caractères larges */
    for (wp = wcs; *wp != 0; wp++) {
        printf("    %lc ", (wint_t) *wp);
        if (!iswalpha(*wp))
            printf("!");
        printf("alpha ");
        if (iswalpha(*wp)) {
            if (iswupper(*wp))
                printf("majuscule ");
            if (iswlower(*wp))
                printf("minuscule ");
        }
        putchar('\n');
    }
    exit(EXIT_SUCCESS);
}

VOIR AUSSI
mblen(3), mbsrtowcs(3), mbtowc(3), wctomb(3), wcstombs(3)

COLOPHON
Cette page fait partie de la publication 3.70 du projet man-pages Linux. Une description du projet et des instructions pour signaler des anomalies peuvent être trouvées à l'adresse http://www.kernel.org/doc/man-pages/.

TRADUCTION
Depuis 2010, cette traduction est maintenue à l'aide de l'outil po4a <http://po4a.alioth.debian.org/> par l'équipe de traduction francophone au sein du projet perkamon <http://perkamon.alioth.debian.org/>.

Christophe Blaess <http://www.blaess.fr/christophe/> (1996-2003), Alain Portal <http://manpagesfr.free.fr/> (2003-2006). Florentin Duneau et l'équipe francophone de traduction de Debian (2006-2009).

Veuillez signaler toute erreur de traduction en écrivant à <perkamon-fr@traduc.org>.

Vous pouvez toujours avoir accès à la version anglaise de ce document en utilisant la commande « LC_ALL=C man <section> <page_de_man> ».