Open System Services Library Calls Reference Manual (G06.29+, H06.08+, J06.03+)

wcsrtombs(3) OSS Library Calls Reference Manual
NAME
wcsrtombs - Convert a wide-character string to a character string (restartable)
LIBRARY
H-series and J-series native Guardian processes: $SYSTEM.ZDLLnnn.ZCRTLDLL
32-bit H-series and J-series OSS processes: /G/system/zdllnnn/zcrtldll
64-bit H-series and J-series OSS processes: /G/system/zdllnnn/ycrtldll
SYNOPSIS
#include <wchar.h>
size_t wcsrtombs(
char *dst,
const wchar_t **src,
size_t len,
mbstate_t *ps
);
PARAMETERS
dst Points to the wide-character object.
src Points to the character.
len The number of bytes to process.
ps Points to the mbstate_t object.
DESCRIPTION
The wcsrtombs() function converts a sequence of wide-characters from the array indirectly
pointed to by src into a sequence of corresponding characters, beginning in the conversion state
described by the object pointed to by ps. If dst is not a null pointer, the converted characters are
then stored into the array pointed to by dst. Conversion continues up to and including a terminat-
ing null wide-character, which is also stored. Conversion stops earlier in the following cases:
• When a code is reached that does not correspond to a valid character.
• When the next character would exceed the limit of len total bytes to be stored in the
array pointed to by dst (and dst is not a null pointer).
Each conversion takes place as if by a call to the wcrtomb() function.
If dst is not a null pointer, the pointer object pointed to by src is assigned either a null pointer (if
conversion stopped because it reached a terminating null wide-character) or the address just past
the last wide-character converted (if any). If conversion stopped because it reached terminating
null wide-character, the resulting state described is the initial conversion state.
If ps is a null pointer, the wcsrtombs( ) function use its own internal mbstate_t object, which is
initialized at program startup to the initial conversion state. Otherwise the mbstate_t object
pointed to by ps is used to completely describe the current conversion state of the associated
character sequence. The implementation behaves as if no function defined in this specification
calls wcsrtombs( ).
RETURN VALUES
If conversion stops because a code is reached that does not correspond to a valid character, an
encoding error occurs. In this case, wcsrtombs( ) sets errno to [EILSEQ] and returns (size_t)(-1),
and the conversion state is undefined. Otherwise, wcsrtombs( ) returns the number of bytes in
the resulting character sequence, not including the terminating null character (if any).
8−22 Hewlett-Packard Company 527187-017