$Str: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
No edit summary
Line 6: Line 6:
This function takes a longstring input and produces a string output, silently truncating the result at 255 bytes or shorter if the target is shorter.  
This function takes a longstring input and produces a string output, silently truncating the result at 255 bytes or shorter if the target is shorter.  


The $Str function accepts one argument and returns a string result that is the first argument truncated at the $function target's length.  
The <var>$Str</var> function accepts one argument and returns a string result that is the first argument truncated at the $function target's length.  


The first argument is an arbitrary string.
The first argument is an arbitrary string.


==Syntax==
==Syntax==
<p class="syntax"><span class="term">%STR</span> = <span class="literal">$Str</span>(<span class="term">longstring</span>)
<p class="syntax"><span class="term">%str</span> = <span class="literal">$Str</span>(<span class="term">longstring</span>)
</p>
</p>
<p>
<p>
</p>
<var class="term">%str</var> is up to the first 255 bytes of <var class="term">longstring</var>.</p>
<p>%STR is up to the first 255 bytes of '''longstring'''.</p>


For example, if %LINCOLN was a LONGSTRING %variable containing the text of the '''Gettysburg Address''' and %AGE was a STRING LEN 20
==Usage notes==
 
<ul>
<p class="code"> %AGE = $Str(%LINCOLN)
<li>The main utility of the <var>$Str</var> function is to prevent the request cancellation that would result from a direct assignment from a LONGSTRING value to a STRING %variable that is too small to hold the entire value. While the input to <var>$Str</var> could be a regular STRING, this doesn't really make much sense since a regular STRING can be assigned to a regular STRING without request cancellation for truncation, anyway.
<p>
A <var>$Str</var> would upgrade an argument WITH expression to a LONGSTRING WITH expression, but this is again rather silly as the result would then simply be truncated at 255 bytes if it exceeds 255 bytes.
</p>
</p>
would result in %AGE containing "Four score and seven".
<li><var>$Str</var> also makes sense as a quick shorthand for the first 255 bytes of a LONGSTRING, even if the target is a LONGSTRING.  
 
</ul>
The main utility of the $Str function is to prevent the request cancellation that would result from a direct assignment from a LONGSTRING value to a STRING %variable that is too small to hold the entire value. While the input to $Str could be a regular STRING this doesn't really make much sense since a regular STRING can be assigned to a regular STRING without request cancellation for truncation, anyway. A $Str would upgrade a WITH expression that's its argument to a LONGSTRING WITH expression but this is again rather silly as the result would then simply be truncated at 255 bytes should it exceed 255 bytes. $Str also makes sense as a quick shorthand for the first 255 bytes of a LONGSTRING, even if the target is a LONGSTRING.  
 
<var>$Str</var> is only available in <var class="product">[[Sirius Mods]]</var> Version 6.2 and later.


==Products authorizing {{PAGENAMEE}}==  
==Products authorizing {{PAGENAMEE}}==  
Line 38: Line 37:
<li>[[Sir2000 Field Migration Facility]]</li>
<li>[[Sir2000 Field Migration Facility]]</li>
</ul>
</ul>
<p>
</p>


[[Category:$Functions|$Str]]
[[Category:$Functions|$Str]]

Revision as of 00:15, 16 April 2013

Treat a longstring as string

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Str function.

This function takes a longstring input and produces a string output, silently truncating the result at 255 bytes or shorter if the target is shorter.

The $Str function accepts one argument and returns a string result that is the first argument truncated at the $function target's length.

The first argument is an arbitrary string.

Syntax

%str = $Str(longstring)

%str is up to the first 255 bytes of longstring.

Usage notes

  • The main utility of the $Str function is to prevent the request cancellation that would result from a direct assignment from a LONGSTRING value to a STRING %variable that is too small to hold the entire value. While the input to $Str could be a regular STRING, this doesn't really make much sense since a regular STRING can be assigned to a regular STRING without request cancellation for truncation, anyway.

    A $Str would upgrade an argument WITH expression to a LONGSTRING WITH expression, but this is again rather silly as the result would then simply be truncated at 255 bytes if it exceeds 255 bytes.

  • $Str also makes sense as a quick shorthand for the first 255 bytes of a LONGSTRING, even if the target is a LONGSTRING.

Products authorizing $Str