The ifx_gl_wcscpy() function
The ifx_gl_wcscpy() function copies a wide-character string.
Syntax
#include <ifxgls.h>
...
int ifx_gl_wcscpy(wcs1, wcs2, wcs2_char_length)
gl_wchar_t *wcs1;
gl_wchar_t *wcs2;
int wcs2_char_length;- 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.
| Valid in client application | Valid in DataBlade® UDR |
|---|---|
| Yes | Yes |
Usage
The ifx_gl_wcscpy() function copies the wide-character string wcs2 to the location that wcs1 references. 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.