MBSRTOWCS(3)

NOM
mbsrtowcs - Convertir une séquence multi-octets en chaîne de caractères larges

SYNOPSIS
#include <wchar.h>

size_t mbsrtowcs(wchar_t *dest, const char **src,
                 size_t len, mbstate_t *ps);

DESCRIPTION
Si dest n'est pas un pointeur NULL, la fonction mbsrtowcs() convertit la séquence multi-octets *src en une chaîne de caractères larges débutant en dest. Au maximum, len caractères larges seront écrits dans dest. L'état de conversion *ps est mis à jour. La conversion est en fait réalisée en invoquant à répétition mbrtowc(dest, *src, n, ps) où n est un nombre positif, aussi longtemps que cet appel réussit, en incrémentant chaque fois dest de un et en augmentant *src du nombre d'octets lus. La conversion peut s'arrêter pour trois raisons :

1.  Une séquence multi-octets invalide a été rencontrée. Dans ce cas, *src pointera sur la séquence invalide, et la fonction renvoie (size_t) -1 en remplissant errno avec la valeur EILSEQ.

2.  len caractères larges différents de L'\0' ont été enregistrés en dest. Dans ce cas, *src pointe sur la séquence multi-octets suivante, et le nombre de caractères larges écrites dans dest est renvoyé.

3.  La séquence multi-octets a été complètement convertie, y compris le L'\0' final (ce qui a pour effet de bord de ramener *ps à l'état initial). Dans ce cas, *src est mis à NULL, et le nombre de caractères écrits dans dest, sauf le L'\0' final, est renvoyé.

Si dest est NULL, alors len est ignoré, et la conversion se déroule comme précédemment, sauf que les caractères convertis ne sont pas écrits en mémoire, et qu'aucune limite de destination n'est prise en compte.

Dans tous les cas, si ps est un pointeur NULL, un état anonyme statique, réservé à la fonction mbsrtowcs() est utilisé à sa place.

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

VALEUR RENVOYÉE
La fonction mbsrtowcs() renvoie le nombre de caractères larges placés dans la zone convertie, sans compter l'octet nul final. Si une séquence multi-octets invalide est rencontrée, la fonction renvoie (size_t) -1, et errno contient EILSEQ.

CONFORMITÉ
C99.

NOTES
Le comportement de mbsrtowcs() dépend de la catégorie LC_CTYPE des paramètres régionaux en vigueur.

L'utilisation d'un pointeur NULL pour ps n'est pas sûre dans un contexte multithreads.

VOIR AUSSI
iconv(3), mbsnrtowcs(3), mbstowcs(3)

TRADUCTION

Ce document est une traduction réalisée par Christophe Blaess <http://www.blaess.fr/christophe/> le 29 août 2000 et révisée le 17 juillet 2008.

L'équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité. La version anglaise la plus à jour de ce document est toujours consultable via la commande : « LANG=C man 3 mbsrtowcs ». N'hésitez pas à signaler à l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.