Difference between revisions of "Extensions.StringUtil.Decode"

From emotive
Jump to navigation Jump to search
m (Hb moved page Decode to Extensions.StringUtil.Decode: #3153)
Line 1: Line 1:
[[Category:StringUtil]]
+
{{DISPLAYTITLE:'''Decode '''}}[[Category:StringUtil]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | Decode | Decodes a string | [[Term]] | [[StringUtil|OTX StringUtil extension]] | [[StringUtil related terms]] | [[UnknownEncodingException]] <br/> [[OutOfBoundsException]] | - }}
+
{{ClassificationActivity | Decode | Decodes a string | [[Term]] | [[Extensions.StringUtil|OTX StringUtil extension]] | [[StringUtil related terms]] | [[Extensions.StringUtil.UnsupportedEncodingException|UnsupportedEncodingException]] <br/> [[OutOfBoundsException]] | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 11: Line 11:
 
The '''Decode''' term decodes the specified '''ByteField''' corresponding to the specified encoding and returns a '''String''' as a result.
 
The '''Decode''' term decodes the specified '''ByteField''' corresponding to the specified encoding and returns a '''String''' as a result.
  
{{TermReturnValue| [[String]] | Decoded string according to the given encoding.}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | Decoded string according to the given encoding.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ByteField | [[ByteField]] | [[Term]] | - | [1] | Bytefield is converted according to the encoding in the string}}
+
{{TableRowPropertie1| ByteField | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | Bytefield is converted according to the encoding in the string}}
{{TableRowPropertie1| Encoding | [[Encoding]] | [[Value]] | @Encoding:US-ASCII | [1] | Encoding is applied to the string}}
+
{{TableRowPropertie1| Encoding | [[Extensions.StringUtil.Encoding|Encoding]] | [[Value]] | @Encoding:US-ASCII | [1] | Encoding is applied to the string}}
 
|}
 
|}
  
Line 27: Line 27:
  
 
== See also ==
 
== See also ==
[[ReplaceSubString]] <br/>
+
[[Extensions.StringUtil.ReplaceSubString|ReplaceSubString]] <br/>
[[MatchToRegularExpression]] <br/>
+
[[Extensions.StringUtil.MatchToRegularExpression|MatchToRegularExpression]] <br/>
[[StringConcatenate]] <br/>
+
[[Extensions.StringUtil.StringConcatenate|StringConcatenate]] <br/>
[[SubString]] <br/>
+
[[Extensions.StringUtil.SubString|SubString]] <br/>
[[LengthOfString]] <br/>
+
[[Extensions.StringUtil.LengthOfString|LengthOfString]] <br/>
[[IndexOf]] <br/>
+
[[Extensions.StringUtil.IndexOf|IndexOf]] <br/>
[[SplitString]] <br/>
+
[[Extensions.StringUtil.SplitString|SplitString]] <br/>
[[ToUpper]] <br/>
+
[[Extensions.StringUtil.ToUpper|ToUpper]] <br/>
[[ToLower]] <br/>
+
[[Extensions.StringUtil.ToLower|ToLower]] <br/>
[[Encode]]
+
[[Extensions.StringUtil.Encode|Encode]]

Revision as of 03:50, 16 February 2016

Classification

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

OTL Syntax

StringTerm = Decode(ByteFieldTerm, EncodingType);

Description

The Decode term decodes the specified ByteField corresponding to the specified encoding and returns a String as a result.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
String Decoded string according to the given encoding.

Properties

Name Data Type Class Default Cardinality Description
ByteField ByteField Term - [1] Bytefield is converted according to the encoding in the string
Encoding Encoding Value @Encoding:US-ASCII [1] Encoding is applied to the string

OTL Examples

String result;
result = Decode(&46464646, @Encoding:US-ASCII);

See also

ReplaceSubString
MatchToRegularExpression
StringConcatenate
SubString
LengthOfString
IndexOf
SplitString
ToUpper
ToLower
Encode