Extensions.StringUtil.Encode

Classification

Name	Encode
Short Description	Encodes a string
Class	Term
Extension	OTX StringUtil extension
Group	StringUtil related terms
Exceptions	UnsupportedEncodingException OutOfBoundsException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

/// Local Declarations
ByteField ByteFieldVariable;
/// Flow
ByteFieldVariable = StringUtil.Encode(EncodingTerm, StringTerm);

Description

The Encode term shall encode a String by using a given encoding. The result is a ByteField representing the encoded string.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
ByteField	Encoded string according to the given encoding.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Encoding	Encoding	Term	@Encoding:US-ASCII	[1]	This represents the encoding to be used. The set of standard encodings which shall be supported by any runtime system is given by the Encoding enumeration.
String	String	Term	-	[1]	Represents the string which shall be transformed to a ByteField by using the given encoding.

OTL Examples

/// Local Declarations

ByteField ByteField1;

/// Flow

ByteField1 = StringUtil.Encode(@Encoding:US-ASCII, "FFFF");

See also

ReplaceSubString
MatchToRegularExpression
StringConcatenate
SubString
LengthOfString
IndexOf
SplitString
ToUpper
ToLower
Decode