DataBloc::WriteString

The DataBloc::WriteString function writes a string (in ANSI or Unicode) in the memory block.

Syntax

WriteString(
    [number] Offset,
    [string] String,
    [number,optional] WriteUnicode
);

Parameters

Offset

[number] Index in the memory block where the string will be written. It must be between 0 and Size - (String.length * 2) - 2 if WriteUnicode is true and between 0 and Size - String.length - 1 if WriteUnicode is false.

String

[string] Text to write to the memory block.

WriteUnicode

[boolean,optional] Specifies if the string to is to be written is ANSI or Unicode. The default if not specified is true for Unicode. If the string is written in ANSI, it is converted with the system's code page.

Return Value

There is no value returned by this function.

This function typically fails for the following reason:

• The Offset parameter is not in the range of possible valid values.

Remarks

Messenger Plus! writes the entire string stopping at the first null character encountered (or at the end of the string). The ending null character is always written in the memory block.

Function Information

See Also

DataBloc Object, ReadString.