Encoding Action Plugin

Actions

Encoding.ConvertFile(string InputFilename, string fromEncoding, string OutputFilename, string toEncoding);

Description:

Reads the contents of a text file in one encoding and saves it using different encoding.

InputFilename:

(string) The full path to the input text file.

fromEncoding:

(string) The encoding of the source file to be read.

OutputFilename:

(string) The full path to the output text file.

toEncoding:

(string) The encoding of the destination text file.

Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

Encoding.ConvertString(string InputString, string fromEncoding, string toEncoding);

Description:

Converts a string from one encoding to another string with different encoding.

InputString:

(string) The full path to the input text file.

fromEncoding:

(string) The encoding of the source file to be read.

toEncoding:

(string) The encoding of the destination text file.

Returns:

(string) The converted string in the new character encoding. You can use Application.GetLastError to determine whether this action failed, and why.

Encoding.ReadToTable(string Filename, string fromEncoding, string toEncoding);

Description:

Reads the contents of a text file in a certain encoding and returns it as a table in a different encoding.

Filename:

(string) The full path to the text file.

fromEncoding:

(string) The encoding of the source file to be read.

toEncoding:

(string) The optional encoding of the converted text in the table. The default is "iso-8859-1" (ANSI Latin-1).

Returns:

(table) The converted text file as table. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- read a text file in Unicode encoding
strFile = _TempFolder .. "\\TextFile.txt";
myTable = Encoding.ReadToTable(strFile, "unicode", "windows-1251");
error = Application.GetLastError();
if (error ~= 0) then
    Dialog.Message("Error", "Got error code " .. error .. " while converting from Unicode", MB_OK, MB_ICONEXCLAMATION);
else
    -- now read each line in the table
    for i, text in myTable do
        Dialog.Message("info", "line " .. i .. " contains: " .. text, MB_OK);
    end
end

Encoding.ReadToString(string Filename, string fromEncoding, string toEncoding);

Description:

Reads the contents of a text file in one encoding and returns it as a string in a different encoding.

Filename:

(string) The full path to the text file.

fromEncoding:

(string) The encoding of the source file to be read.

toEncoding:

(string) The optional encoding of the converted text in the string. The default is "iso-8859-1" (ANSI Latin-1).

Returns:

(string) The converted text file as string. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- read a XML file in UTF-8 encoding
strXMLPath = _TempFolder .. "\\utf8File.xml";
convertedXml = Encoding.ReadToString(strXMLPath, "utf-8");
error = Application.GetLastError();
if (error ~= 0) then
    Dialog.Message("Error", "Got error code " .. error .. " while converting from UTF-8", MB_OK, MB_ICONEXCLAMATION);
else
    -- everything ok, proceed with XML processing...
    XML.SetXML(convertedXml);
end

Encoding.WriteFromTable(string Filename, table Text, string toEncoding, string fromEncoding);

Description:

Writes a table's contents out to a text file. The table should consist of one line of text per table item.

Filename:

(string) The full path to the text file.

Text:

(table) The lines of text to write.

toEncoding:

(string) The encoding of the file to be written.

fromEncoding:

(string) The optional encoding of the text in the table. If omitted, "iso-8859-1" (ANSI Latin-1) is assumed.

Returns:

(nothing) You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- save a table as text file with UTF-8 encoding
Encoding.WriteFromTable(_TempFolder .. "\\utf8File.txt", myTable, "utf-8");
if (error ~= 0) then
    Dialog.Message("Error", "Got error code " .. error .. " while converting to UTF-8", MB_OK, MB_ICONEXCLAMATION);
end

Encoding.WriteFromString(string Filename, string Text, string toEncoding, string fromEncoding);

Description:

Writes a string of text to a new file in a specific character encoding.

Filename:

(string) The full path to the text file.

Text:

(string) The string of text to write.

toEncoding:

(string) The encoding of the file to be written. Allowed options are: "iso-8859-1", "utf-8" and "unicode".

fromEncoding:

(string) The optional encoding of the text stored in the string. If omitted, "iso-8859-1" (ANSI Latin-1) is assumed.

Returns:

(nothing) You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- save a string with Russian text as a file in Unicode encoding
Encoding.WriteFromString(_TempFolder .. "\\unicodeFile.txt", myString, "unicode", "windows-1251");
if (error ~= 0) then
    Dialog.Message("Error", "Got error code " .. error .. " while converting to Unicode", MB_OK, MB_ICONEXCLAMATION);
end