$C2D: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
(36 intermediate revisions by 5 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">Convert binary byte string to integer</span>
<span class="pageSubtitle">Convert binary byte string to integer</span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$C2D</var> function is the [[BinaryToInteger (String function)]]. For a full list of string and numeric conversion functions see [[List of String methods]] and [[List of Float methods]].</p>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $C2D function is the <var>[[BinaryToInteger (String function)|BinaryToInteger]]</var> function. For a full list of string and numeric conversion functions see [[List of String methods]] and [[List of Float methods]].</p>


The <var>$C2D</var> function returns the integer which is represented by a binary byte string argument.  
The <var>$C2D</var> function returns the integer which is represented by a binary byte string argument.  
Line 14: Line 14:
The returned result is the integer represented, in binary, by the byte string value of argument one. This is obtained from the rightmost bytes of the first argument, after any padding or truncating to the length specified by argument 2. If the length of argument one is 4 or more, or if argument two is less than or equal to the length of argument one, these bytes are treated as a signed number; otherwise they are treated as an unsigned number. A zero is returned for invalid arguments.
The returned result is the integer represented, in binary, by the byte string value of argument one. This is obtained from the rightmost bytes of the first argument, after any padding or truncating to the length specified by argument 2. If the length of argument one is 4 or more, or if argument two is less than or equal to the length of argument one, these bytes are treated as a signed number; otherwise they are treated as an unsigned number. A zero is returned for invalid arguments.
==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %VALUE = $C2D (byte_string, width)
<p class="syntax"><span class="term">%value</span> = <span class="literal">$C2D</span>(<span class="term">byte_string</span>, [<span class="term">width</span>])
<section end="syntax" /></p>
<p class="caption">$C2D Function
</p>
</p>
<p class="caption">%VALUE is set to the integer represented by the byte string.</p>


<p>
<var class="term">%value</var> is set to the integer represented by the byte string.</p>


==Usage notes==
<var>$C2D</var> is similar to the standard <var>[[$Unbin]]</var> function, with some differences, such as being able to specify the input length in bytes rather than bits, and being able to specify input lengths other than 2 or 4 bytes in length.
The inverse of <var>$C2D</var> is <var>[[$D2C]]</var>. See also the <var>[[$D2X]]</var> and <var>[[$X2D]]</var> functions, and see the <var>[[$C2X]]</var> and <var>[[$X2C]]</var> functions.
==Examples==
The following program will print the value -1:
The following program will print the value -1:
<p class="code"> B
<p class="code">B
PRINT $C2D($X2C('FF'), 1)
PRINT $C2D($X2C('FF'), 1)
END
END
</p>
</p>
Here are some other results, with the input shown using hexadecimal representation, or as "''" to indicate the null string:
 
<p class="code"> $C2D(X'09') -> 9
Here are some other results, with the input shown using hexadecimal representation, or as &apos; &apos; to indicate the null string:
$C2D(X'81') -> 129
<p class="code">$C2D(X'09') -> 9
$C2D(X'FF81') -> 65409
$C2D(X'81') -> 129
$C2D('') -> 0
$C2D(X'FF81') -> 65409
$C2D(X'81') -> 129
$C2D(&apos;&apos;) -> 0
$C2D(X'81', 1) -> -127
$C2D(X'81') -> 129
$C2D(X'81', 2) -> 129
$C2D(X'81', 1) -> -127
$C2D(X'FF81', 2) -> -127
$C2D(X'81', 2) -> 129
$C2D(X'FF81', 1) -> -127
$C2D(X'FF81', 2) -> -127
$C2D(X'FF7F', 1) -> 127
$C2D(X'FF81', 1) -> -127
$C2D(X'F081', 2) -> -3967
$C2D(X'FF7F', 1) -> 127
$C2D(X'F081', 1) -> -127
$C2D(X'F081', 2) -> -3967
$C2D(X'0031', 0) -> 0
$C2D(X'F081', 1) -> -127
$C2D(X'FFFFFFFF') -> -1
$C2D(X'0031', 0) -> 0
$C2D(X'FFFFFF') -> 16777215
$C2D(X'FFFFFFFF') -> -1
$C2D(X'FFFFFF') -> 16777215
</p>
</p>


$C2D is similar to the standard [[$UnBin]] function (described in the <i>[http://www.rocketsoftware.com/m204/products/index/documentation/v7r4/M204-User-Language/view Rocket Model 204 User Language Manual]</i>), with some differences, such as being able to specify the input length in bytes rather than bits, and being able to specify input lengths other than 2 or 4 bytes in length.
==Products authorizing {{PAGENAMEE}}==
 
The inverse of <var>$C2D</var> is [[$D2C]]. See also the [[$D2X]] and [[$X2D]] functions (in this manual) and the [[$C2X]] and [[$X2C]] functions (in the <var class="product">Rocket Model 204 User Language Manual</var>).
 
<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>[[Japanese functions]]</li>
<li>Japanese functions</li>
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>


</ul>
</ul>

Latest revision as of 22:32, 20 September 2018

Convert binary byte string to integer

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $C2D function is the BinaryToInteger function. For a full list of string and numeric conversion functions see List of String methods and List of Float methods.

The $C2D function returns the integer which is represented by a binary byte string argument.

$C2D accepts one required and one optional argument and returns a numeric value.

The first argument is the binary byte string to be converted to an integer. If it is omitted or is the null string, zero is the result.

The second argument is the number of bytes to use from argument one. If this is longer than argument one, argument one is padded with leading zeroes to this length; otherwise the rightmost bytes of argument one are used. The default is 5.

The returned result is the integer represented, in binary, by the byte string value of argument one. This is obtained from the rightmost bytes of the first argument, after any padding or truncating to the length specified by argument 2. If the length of argument one is 4 or more, or if argument two is less than or equal to the length of argument one, these bytes are treated as a signed number; otherwise they are treated as an unsigned number. A zero is returned for invalid arguments.

Syntax

%value = $C2D(byte_string, [width])

%value is set to the integer represented by the byte string.

Usage notes

$C2D is similar to the standard $Unbin function, with some differences, such as being able to specify the input length in bytes rather than bits, and being able to specify input lengths other than 2 or 4 bytes in length.

The inverse of $C2D is $D2C. See also the $D2X and $X2D functions, and see the $C2X and $X2C functions.

Examples

The following program will print the value -1:

B PRINT $C2D($X2C('FF'), 1) END

Here are some other results, with the input shown using hexadecimal representation, or as ' ' to indicate the null string:

$C2D(X'09') -> 9 $C2D(X'81') -> 129 $C2D(X'FF81') -> 65409 $C2D('') -> 0 $C2D(X'81') -> 129 $C2D(X'81', 1) -> -127 $C2D(X'81', 2) -> 129 $C2D(X'FF81', 2) -> -127 $C2D(X'FF81', 1) -> -127 $C2D(X'FF7F', 1) -> 127 $C2D(X'F081', 2) -> -3967 $C2D(X'F081', 1) -> -127 $C2D(X'0031', 0) -> 0 $C2D(X'FFFFFFFF') -> -1 $C2D(X'FFFFFF') -> 16777215

Products authorizing $C2D

Products authorizing $C2D

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$C2D&oldid=116803"