Difference between revisions of "Extensions.StringUtil.Encode"
Jump to navigation
Jump to search
m (Hb moved page Encode to Extensions.StringUtil.Encode: #3153) |
|||
| Line 1: | Line 1: | ||
| − | [[Category:StringUtil]] | + | {{DISPLAYTITLE:'''Encode '''}}[[Category:StringUtil]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | Encode | Encodes a string | [[Term]] | [[StringUtil|OTX StringUtil extension]] | [[StringUtil related terms]] | [[ | + | {{ClassificationActivity | Encode | Encodes 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 '''Encode''' term encodes the specified string corresponding to the specified encoding and returns a '''ByteField''' as a result. | The '''Encode''' term encodes the specified string corresponding to the specified encoding and returns a '''ByteField''' as a result. | ||
| − | {{TermReturnValue| [[ByteField]] | Encoded string according to the given encoding.}} | + | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | Encoded string according to the given encoding.}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| String | [[String]] | [[Term]] | - | [1] | The original string}} | + | {{TableRowPropertie1| String | [[Core.DataTypes.SimpleDataType.String|String]] | [[Term]] | - | [1] | The original 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/> |
| − | [[Decode]] | + | [[Extensions.StringUtil.Decode|Decode]] |
Revision as of 03:48, 16 February 2016
Contents
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
ByteFieldTerm = Encode(StringTerm, EncodingType);Description
The Encode term encodes the specified string corresponding to the specified encoding and returns a ByteField as a result.
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 |
| String | String | Term | - | [1] | The original string |
| Encoding | Encoding | Value | @Encoding:US-ASCII | [1] | Encoding is applied to the string |
OTL Examples
ByteField result;
result = Encode("FFFF", @Encoding:US-ASCII);See also
ReplaceSubString
MatchToRegularExpression
StringConcatenate
SubString
LengthOfString
IndexOf
SplitString
ToUpper
ToLower
Decode
