The ifx_gl_wcsncpy() function

The ifx_gl_wcsncpy() function copies a specified number of wide characters from a wide-character string.

Syntax

#include <ifxgls.h>
...
int ifx_gl_wcsncpy(wcs1, wcs2, wcs2_char_length, char_limit)
       gl_wchar_t *wcs1;
       gl_wchar_t *wcs2;
       int wcs2_char_length;
       int char_limit;
wcs1
A pointer to the location where the function copies wcs2.
wcs2
A pointer to the wide-character string to copy to wcs1.
wcs2_char_length
The integer number of characters in the wcs2 string. If wcs2_char_length is the value IFX_GL_NULL, the function assumes that wcs2 is a null-terminated string.
char_limit
The maximum number of wide characters to read from wcs2.
Valid in client application Valid in DataBlade® UDR
Yes Yes

Usage

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

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

If an error occurred, this function returns -1 and sets the ifx_gl_lc_errno() error number to the following value.
IFX_GL_PARAMERR
The wcs2_char_length is not equal to IFX_GL_NULL and is not greater than or equal to 0.