| nOffset | (Long) Specifies the position of read value in the data block.
The read value must be inside the data block. The item is read either whole or not read at all. >= 0 - Index (in bytes, zero-based index) in the data block.
-4 - The internal automatic position is used (see the AutoOffset property). It points behind the last read or written value.
This operation shifts the internal automatic position behind the read/written value. If the items are read/written one by one then it is not necessary to define the position manually, but it is better to use this automated positioning. |
|---|---|
| nAttr | [optional] (Long) Additional parameters.
0 (default) - The text string is read up to the first NULL character.
1 - The text string is read to the end of the data block. |
| nEncoding | [optional] (Long) Encoding of a text string in the data block.
0 (default) - (ANSI) Each character is stored in a single byte. The values from 0 to 127 represent an ASCII character table that is not changing in meaning. The values from 128 to 255 have different meaning in various localizations (code pages, e.g. Windows 1250).
1 - (UTF-8) Each character is stored in 1, 2 or 4 bytes, it means has variable length. The advantage is that the latin characters (ASCII) are stored in a single byte. Only special characters and characters with diacritics (i.e. national dependent characters) are stored in multiple bytes. This storage is therefore very efficient.
This encoding is commonly used for data exchange, data persistence and on the Web. 2 - (UTF-16) Each character is stored in 2 bytes (or exceptionally in 4 bytes), i.e. it has a fixed length. The advantage is that most characters are stored in 2 bytes so these strings are easy to work with (because of the fixed length).
This encoding is used internally in Windows OS, but also in the JavaScript language or .NET, because the mannipulation with these fixed strings is easier. 3 - (UTF-16 BE) (Big Endian) Each character is stored in 2 bytes (or exceptionally in 4 bytes), i.e. it has a fixed length. The advantage is that most characters are stored in 2 bytes so these strings are easy to work with (because of the fixed length).
This encoding is used internally in Windows OS, but also in the JavaScript language or .NET, because the mannipulation with these fixed strings is easier. |
var oBuf = Pm.CreatePmBuffer();
var s1 = "Help me!";
oBuf.SetStringVar(-2, s1, 0, 1);
oBuf.AutoOffset = 0;
var val = oBuf.GetStringVar(-4, 0, 1);
// val = "Help me!"