The ifx_gl_getmb() function

Syntax

#include <ifxgls.h>
...
int ifx_gl_fgetmb(mb, funcp, v, bytes_got)
       gl_mchar_t *mb;
       int (*funcp)(void *v);
       void *v;
       int *bytes_got;

mb

A pointer to the multibyte character whose bytes the funcp function reads from a specified location.

funcp

A pointer to a function that you define to specify the location from which to read the multibyte character.

v

A pointer that the ifx_gl_getmb() function passes to the funcp function each time that it is called.

bytes_got

A pointer to an integer that ifx_gl_getmb() sets to indicate the number of bytes that the funcp function has successfully read.

Usage

The ifx_gl_getmb() function calls a function that you define to obtain the bytes that form one multibyte character from a specified location. This multibyte character is then written to the mb buffer.

int funcp(void *v)

The pointer v is passed to funcp each time that it is called. On success, funcp must return a value 0 - 255, inclusive, which is the next byte of the multibyte character. On failure, funcp must return -1.

Of these two options, the macro IFX_GL_MB_MAX is faster, and it can be used to initialize static buffers. The function ifx_gl_mb_loc_max() is slower but more precise.

The number of bytes that funcp successfully reads is returned in bytes_got (even when funcp fails).

Return values

0 - 255

The value of the next byte for the multibyte character

-1

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

Errors