The ifx_gl_iswcntrl() function

The ifx_gl_iswcntrl() function determines whether a wide character contains a control character.

Syntax

#include <ifxgls.h>
...
int ifx_gl_iswcntrl(wc)
       gl_wchar_t *wc;
wc
A pointer to the wide character whose character classification you want to determine.
Valid in client application Valid in DataBlade® UDR
Yes Yes

Usage

The ifx_gl_iswcntrl() function tests whether wc is in the cntrl character class according to the rules of the current locale. The cntrl character class contains the single-byte control characters: alert, backspace, tab, newline, vertical tab, form feed, carriage return, NUL, SOH, STX, ETX, EOT, ENQ, ACK, SO, SI, DLE, DC1, DC2, DC3, DC4, NAK, SYN, ETB, CAN, EM, SUB, ESC, IS4, IS3, IS2, IS1, and DEL. These characters are the ASCII characters whose code points are in the range 0x000 to 0x1F. In addition, the cntrl class contains any other control characters that the locale might define.

No characters in the upper, lower, alpha, digit, xdigit, punct, graph, or print classes are in the cntrl class.

Locale information

The LC_CTYPE category of the current locale affects the behavior of this function because it defines the cntrl character class.

Return values

>0
The wc character is in the cntrl character class.
0
The function was not successful, and the error number is set to indicate the cause. See the Errors section.

Errors

This function does not return a unique value to indicate an error. If an error occurred, the function returns 0 and sets the ifx_gl_lc_errno() error number to the following value.
IFX_GL_EILSEQ
The *wc value is not a valid wide character.