The ifx_gl_mbsncpy() function

Syntax

#include <ifxgls.h>
...
int ifx_gl_mbsncpy(mbs1, mbs2, mbs2_byte_length, char_limit)
       gl_mchar_t *mbs1;
       gl_mchar_t *mbs2;
       int mbs2_byte_length;
       int char_limit;

mbs1

A pointer to the location where the function copies mbs2.

mbs2

A pointer to the multibyte-character string to copy to mbs1.

mbs2_byte_length

The integer number of bytes in the mbs2 string. If mbs2_byte_length is the value IFX_GL_NULL, the function assumes that mbs2 is a null-terminated string.

char_limit

The maximum number of multibyte characters to read from mbs2.

Usage

The ifx_gl_mbsncpy() function copies mbs2 to the location that mbs1 references. The function reads no more than char_limit characters from mbs2 and writes them to mbs1. If mbs1 and mbs2 overlap, the results of this function are undefined.

If mbs1 and mbs2 overlap, the results of this function are undefined. If mbs2_byte_length is equal to IFX_GL_NULL, the function null-terminates the concatenated string. Any other value of mbs2_byte_length means that the function does not null-terminate the resulting concatenated string.

Return values

>=0

The number of bytes in the copied string, not including any null terminator.

-1

The function was not successful, and the error number is set to indicate the cause. See the Errors section.

Errors