Command: TextFileEncoding

Download PDF

Updated2023-02-21
2 minute(s) read

Specifies the character encoding of a file. The function uses the Byte Order Mark (BOM) of the file to specify the character encoding.

ReturnValue = TextFileEncoding(FileName)

Input Parameters

FileName

Specifies the filename.

Return Parameters

ReturnValue

The return value is an Integer variable type. Contains the character encoding

4	eTextFileAttributeANSI	Encoded in ANSI.
8	eTextFileAttributeUnicode	Encoded in Unicode.
16	eTextFileAttributeUTF8	Encoded in UTF8.

Examples

The following example specifies the character encoding of a file:

VBScript

Python

Copy script

Dim intMyEncode
intMyEncode = TextFileEncoding(ScriptReadPath & "NewText.txt")
Select Case intMyEncode
Case eTextFileAttributeANSI
  Call MsgBoxDisp("ANSI")
Case eTextFileAttributeUnicode
  Call MsgBoxDisp("Unicode")
Case eTextFileAttributeUTF8
  Call MsgBoxDisp("UTF8")
Case Else
  Call MsgBoxDisp("Error occured")
End Select

intMyEncode = dd.TextFileEncoding(dd.ScriptReadPath + "NewText.txt") 
select_variable_0 = intMyEncode 
if (select_variable_0 == eTextFileAttributeANSI) : 
    dd.MsgBoxDisp("ANSI") 
elif (select_variable_0 == eTextFileAttributeUnicode) : 
    dd.MsgBoxDisp("Unicode") 
elif (select_variable_0 == eTextFileAttributeUTF8) : 
    dd.MsgBoxDisp("UTF8") 
else: 
    dd.MsgBoxDisp("Error occured")

Related Functions

DIAdem API Reference

Table of Contents

Command: TextFileEncoding

Input Parameters

Return Parameters

Examples

Related Functions