mbstomb Subroutine

Purpose

Extracts a multibyte character from a multibyte character string.

Note: The mbstomb subroutine is specific to the manufacturer. It is not defined in the POSIX, ANSI, or X/Open standards. Use of this subroutine may affect portability.

Library

Standard C Library (libc.a)

Syntax

#include <mbstr.h>

mbchar_t mbstomb ( MbString) const char *MbString;

Description

The mbstomb subroutine extracts the multibyte character pointed to by the MbString parameter from the multibyte character string. The LC_CTYPE category affects the behavior of the mbstomb subroutine.

Parameters

Item	Description
MbString	Contains a multibyte character string.

Return Values

The mbstomb subroutine returns the code point of the multibyte character as a mbchar_t data type. If an unusable multibyte character is encountered, a value of 0 is returned.