Method

# GetTextEncoding

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

Returns a `TextEncoding</api/text/encoding_text/textencoding>` object based on user-specified parameters.

## Usage

``` xojo
result = GetTextEncoding(base, variant, format)
```

| Part    | Type                                                 | Description                                                                                 |
|---------|------------------------------------------------------|---------------------------------------------------------------------------------------------|
| result  | `TextEncoding</api/text/encoding_text/textencoding>` | TextEncoding object.                                                                        |
| base    | `Integer</api/data_types/integer>`                   | The type of encoding.                                                                       |
| variant | `Integer</api/data_types/integer>`                   | Optional: Specific variation of *base*.                                                     |
| format  | `Integer</api/data_types/integer>`                   | Optional: Format-only used by Unicode for defining which format of Unicode you wish to use. |

## Notes

See the `TextConverter</api/text/encoding_text/textconverter>` class for the Base and Variant codes. The codes for *format* are as follows:

| Name               | Code |
|--------------------|------|
| Default Format     | 0    |
| Unicode16BitFormat | 0    |
| UnicodeUTF7Format  | 1    |
| UnicodeUTF8Format  | 2    |
| Unicode32BitFormat | 3    |

## Sample code

The following example converts the text in a `TextField</api/user_interface/desktop/desktoptextfield>`:

``` xojo
Var c As TextConverter
c = GetTextConverter(GetTextEncoding(&h500), GetTextEncoding(0))
TextField2.Text = c.Convert(TextField1.Text)
```

## Compatibility

|                       |                       |
|-----------------------|-----------------------|
| **Project Types**     | Console, Desktop, Web |
| **Operating Systems** | All                   |

<div class="seealso">

`ConvertEncoding</api/text/encoding_text/convertencoding>`, `DefineEncoding</api/text/encoding_text/defineencoding>`, `Encoding</api/text/encoding_text/encoding>`, `GetTextConverter</api/text/encoding_text/gettextconverter>`, `GetFontTextEncoding</api/text/encoding_text/getfonttextencoding>`, `GetInternetTextEncoding</api/text/encoding_text/getinternettextencoding>` functions; `Encodings</api/text/encoding_text/encodings>` module; `TextEncoding</api/text/encoding_text/textencoding>`, `TextConverter</api/text/encoding_text/textconverter>` classes.

</div>