GetUnicode Method

9.6A, PLBCMP GUI Only

The GetUnicode method retrieves the raw Unicode (UTF-16) data from an EDITTEXT or RICHEDITTEXT object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An EDITTEXT or RICHEDITTEXT object that is accessed.

return

Optional. A Character String Variable that receives the Unicode (UTF-16) data.

flags

Optional. A Numeric Variable or decimal number that controls operational behaviors for this method.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The OVER and ZERO flags are always cleared.

2. The EOS flag is set if the returned data is truncated because the {return} variable is too small.

3. The bit mask definitions for the {flags} parameter are defined as follows:

 

Value	Behavior
0x1	Strip trailing Unicode NULL termination characters.

 

4. The CONVERTUTF instruction performs UTF conversions to and from UTF-16 formatted data strings.

5. Support for RICHEDITEXT objects was added in version 9.6C.

See Also: SetUnicode Method, Method Syntax, EDITTEXT Methods, RICHEDITTEXT Methods