DefineEncoding Function

Returns a String with the same data as the given string, but with the encoding of the given encoding. This function is useful when you have a string whose encoding is known to you but not to REALbasic.

Syntax
result = DefineEncoding( str, enc )
result = str.DefineEncoding( enc )

Parameters
str | String | The String to be encoded.
enc | TextEncoding | The TextEncoding to be used to encode str.

Return Value
Result | String | The result of encoding str using the encoding specified by enc.

# Notes

REALbasic 'knows' the encoding of the text it creates, so you don't have to use DefineEncoding for any such text.

Consult the values of Base entry for TextEncoding when creating the TextEncoding object using the GetTextEncoding function.

# Example

The following example takes 8 bytes from a MemoryBlock and sets the encoding to UTF16.

Editfield1.text=DefineEncoding(MyMemoryBlock.StringValue(0,8), _ Encodings.UTF16 )

This example uses DefineEncoding when reading text via a TCPSocket.

EditField1.Text = DefineEncoding( TCPSocket1.ReadAll, Encodings.ASCII )

# See Also

TextEncoding class; ConvertEncoding, Encoding, GetTextEncoding functions; Encodings object.