$Lstr X2C: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{DISPLAYTITLE:$Lstr_X2C}} <span class="pageSubtitle"><section begin="desc" />Convert from hexadecimal to byte string<section end="desc" /></span> <p class="warning">Most Sirius...") |
(Automatically generated page update) |
||
| (38 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:$Lstr_X2C}} | {{DISPLAYTITLE:$Lstr_X2C}} | ||
<span class="pageSubtitle" | <span class="pageSubtitle">Convert from hexadecimal to byte string</span> | ||
<p class=" | <p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_X2C function is the <var>[[HexToString (String function)|HexToString]]</var> function.</p> | ||
This function converts from a hexadecimal encoded string to the decoded byte string. It is identical to <var>[[$X2C]]</var>, except it is longstring capable. | |||
The <var>$Lstr_X2C</var> function accepts one argument and returns a string result whose hexadecimal encoding is that argument. | |||
The first argument is a Longstring which is a hexadecimal encoding. | |||
The | The returned value is the hexadecimal decoding of the argument string. If the argument is not a valid hexadecimal encoding, the null string is returned. | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%decoded</span> = <span class="literal">$Lstr_X2C</span>(<span class="term">string</span>) | ||
< | |||
< | |||
</p> | </p> | ||
<p> | |||
<var class="term">%decoded</var> is set to the hexadecimal decoding of <var class="term">string</var>.</p> | |||
==usage notes== | |||
<ul> | |||
< | <li>You can check for an invalid hexadecimal encoding by checking for the null string return value from $Lstr_X2C. Of course, if it is possible that the argument is null, the null string is a valid returned value. If you need to check for errors, and the null string is a possible argument value, you can use an approach such as the following: | ||
<p class="code">%STR = $Lstr_X2C(%IN) | |||
<p class="code"> %STR = $Lstr_X2C(%IN) | IF %STR EQ '' | ||
IF %IN NE '' THEN | |||
error code ... | |||
END IF | |||
END IF | |||
</p> | </p> | ||
<li><var>[[$Lstr_C2X]]</var> is the inverse of <var>$Lstr_X2C</var>. | |||
</ul> | |||
==Example== | |||
The following code would print <code>Red rum</code>, which is the character representation of the EBCDIC characters represented in hexadecimal as "D985844099A494": | |||
<p class="code">PRINT $Lstr_X2C('D985844099A494') | |||
</p> | |||
==Products authorizing {{PAGENAMEE}}== | |||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | |||
</ul> | |||
[[Category:$Functions|$Lstr_X2C]] | [[Category:$Functions|$Lstr_X2C]] | ||
Latest revision as of 22:52, 20 September 2018
Convert from hexadecimal to byte string
Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_X2C function is the HexToString function.
This function converts from a hexadecimal encoded string to the decoded byte string. It is identical to $X2C, except it is longstring capable.
The $Lstr_X2C function accepts one argument and returns a string result whose hexadecimal encoding is that argument.
The first argument is a Longstring which is a hexadecimal encoding.
The returned value is the hexadecimal decoding of the argument string. If the argument is not a valid hexadecimal encoding, the null string is returned.
Syntax
%decoded = $Lstr_X2C(string)
%decoded is set to the hexadecimal decoding of string.
usage notes
- You can check for an invalid hexadecimal encoding by checking for the null string return value from $Lstr_X2C. Of course, if it is possible that the argument is null, the null string is a valid returned value. If you need to check for errors, and the null string is a possible argument value, you can use an approach such as the following:
%STR = $Lstr_X2C(%IN) IF %STR EQ '' IF %IN NE '' THEN error code ... END IF END IF
- $Lstr_C2X is the inverse of $Lstr_X2C.
Example
The following code would print Red rum, which is the character representation of the EBCDIC characters represented in hexadecimal as "D985844099A494":
PRINT $Lstr_X2C('D985844099A494')