mbcharscalar (MATLAB Compiler 2.0)

Assert variable is a character scalar.

Syntax

mbcharscalar(x)

Description

The statement

mbcharscalar(x)

causes the MATLAB Compiler to impute that x is a character scalar, i.e., an unsigned short variable. At runtime, if mbcharscalar determines that x holds a value other than a character scalar, mbcharscalar issues an error message and halts execution of the MEX-file.

mbcharscalar tells the MATLAB interpreter to check whether x holds a character scalar value. If x does not, mbcharscalar issues an error message and halts execution of the M-file. The MATLAB interpreter does not use mbcharscalar to impute x.

Note that mbcharscalar only tests x at the point in an M-file or MEX-file where an mbcharscalar call appears. In other words, an mbcharscalar call tests the value of x only once. If x becomes a vector after the mbcharscalar test, mbcharscalar cannot issue an error message.

mbcharscalar defines a character scalar as any value that meets the criteria of both mbchar and mbscalar.

Example

This code in MATLAB generates an error message:

n = ['hello' 'world'];
mbcharscalar(n)
??? Error using ==> mbcharscalar
Argument of mbcharscalar must be scalar.