System.AnsiStringBase.ByteType

From Appmethod Libraries
Jump to: navigation, search

C++

TStringMbcsByteType ByteType(int index) const _ALWAYS_INLINE {

Properties

Type Visibility Source Unit Parent
function public dstring.h System AnsiStringBase

Description

Indicates the kind of byte that occupies a specified position in the AnsiStringBase.

ByteType indicates the kind of byte located at the byte marked by index (counting from 1) in the AnsiStringBase. These are the possible return values.



Constant Meaning

mbSingleByte

Single byte character.

mbLeadByte

Lead byte of a multibyte character

mbTrailByte

Trailing byte of a multibyte character



Some locales, including all Western locales, do not use multibyte characters. Under those locales, ByteType always returns mbSingleByte.

Note: No checking is done to ensure that Index is less than the length of S. The caller must ensure that Index is not out of bounds.

See Also