The ifx_gl_ismspace() function
The ifx_gl_ismspace() function determines whether a multibyte character contains a space (vertical or horizontal) character.
Syntax
#include <ifxgls.h>
...
int ifx_gl_ismspace(mb, mb_byte_limit)
gl_mchar_t *mb;
int mb_byte_limit;- mb
- A pointer to the multibyte character whose character classification you want to determine.
- mb_byte_limit
- The integer number of bytes to read from mb to try to form a complete multibyte character. If mb_byte_limit is IFX_GL_NO_LIMIT, the ifx_gl_ismspace() function reads as many bytes as necessary from mb to form a complete character.
| Valid in client application | Valid in DataBlade® UDR |
|---|---|
| Yes | Yes |
Usage
The ifx_gl_ismspace() function
tests whether mb is in the space character class according to the
rules of the current locale. The space character class contains:
- all characters from the blank class, including the horizontal space character (ASCII 0x020).
- the vertical-space character.
- the single-byte newline, vertical tab, form feed, and carriage return (ASCII 0x00A through 0x00D).
- any multibyte versions of newline, vertical tab, form feed, and carriage return.
No characters in the alpha, digit, xdigit, punct, or graph classes are in this class.
Locale information
The LC_CTYPE category of the current locale affects the behavior of this function because it defines the space character class.
Return values
- >0
- The *mb character is in the space 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
one of the following values.
- IFX_GL_EILSEQ
- The *mb value is not a valid multibyte character.
- IFX_GL_EINVAL
- The function cannot determine whether mb is a valid multibyte character because it would need to read more than mb_byte_limit bytes from mb. If mb_byte_limit is less than or equal to 0, this function always returns this error.