$Lstr Global Del and $Lstr Session Del: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
m (misc formatting and links)
 
(16 intermediate revisions by 3 users not shown)
Line 2: Line 2:
<span class="pageSubtitle">$Lstr_Global_Del and $Lstr_Session_Del</span>
<span class="pageSubtitle">$Lstr_Global_Del and $Lstr_Session_Del</span>


<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Global_Del and $Lstr_Session_Del function.</p>
<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the <var>$Lstr_Global_Del</var> nor the <var>$Lstr_Session_Del</var> function.</p>


These functions delete one or more global or session longstrings that were created with either <var>$Lstr_Global_Set</var>, <var>$Lstr_Session_Set</var>, <var>$Lstr_Global</var>, or <var>$Lstr_Session</var> in the current or any previous <var class="product">User Language</var> program. It returns the number of deleted entries.  
These functions delete one or more global or session longstrings that were created with either <var>$Lstr_Global_Set</var>, <var>$Lstr_Session_Set</var>, <var>$Lstr_Global</var>, or <var>$Lstr_Session</var> in the current or any previous <var class="product">User Language</var> program. It returns the number of deleted entries.  


<var>$Lstr_Global_Del</var> and <var>$Lstr_Session_Del</var> accept one argument and return a numeric result.  
<var>$Lstr_Global_Del</var> and <var>$Lstr_Session_Del</var> accept one argument and return a numeric result.  
The argument is the name of the global or session longstring or longstrings to be deleted. This argument can contain wildcard characters as described below. This is a required argument and cannot be a null string.


==Syntax==
==Syntax==
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Lstr_Global_Del</span>(<span class="term">name)
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Lstr_Global_Del</span>(<span class="term">name</span>)
</p>
</p>
<p>
 
</p>
<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Lstr_Session_Del</span>(<span class="term">name</span>)
<p>%RC is set to number of deleted global longstrings.</p>
<p class="code">  
%RC = $Lstr_Session_Del(name)
</p>
<p>
</p>
</p>
<p>%RC is set to the number of deleted session longstrings.</p>


<table>
<tr><th>%rc</th>
<td>Set to the number of deleted global or session Longstrings.</td></tr>


The name specified for <var>$Lstr_Global_Del</var> or <var>$Lstr_Session_Del</var> can be an explicit name or it can contain the following wildcard characters:
<tr><th>name</th>
<td>A string that contains the name of the global or session [[Longstrings|Longstring]] that is to be deleted. This is a required argument and it cannot be a null string.
<p>
The name specified for <var>$Lstr_Global_Del</var> or <var>$Lstr_Session_Del</var> can be an explicit name or it can contain the following wildcard characters:</p>
<table class="thJustBold">
<tr><th>*</th>
<td>Matches any number of characters including none.</td></tr>


<table class="syntaxTable">
<tr><th>*</th>
<td>Matches any number of characters including none</td></tr>
<tr><th>?</th>
<tr><th>?</th>
<td>Matches any single character</td></tr>
<td>Matches any single character</td></tr>
Line 34: Line 32:
<td>Indicates that the next character must be treated literally even if it is a wildcard character.
<td>Indicates that the next character must be treated literally even if it is a wildcard character.
</td></tr></table>
</td></tr></table>
For example,
</td></tr>
<p class="code"> %RC = $Lstr_Global_Del('TYRANNOSAURUS')
</table>
 
==Examples==
<ol>
<li>To delete only a global longstring named <code>TYRANNOSAURUS</code>:
<p class="code">%RC = $Lstr_Global_Del('TYRANNOSAURUS')
</p>
</p>
would only delete a global longstring named &amp;OSQ.TYRANNOSAURUS&amp;CSQ..
 
<p class="code"> %RC = $Lstr_Global_Del('STEG*')
<li>To delete global longstrings named <code>STEG</code>, <code>STEGOSAURUS</code>,and <code>STEG.DATA</code>, if they existed:
<p class="code">%RC = $Lstr_Global_Del('STEG*')
</p>
</p>
would delete globals longstrings named &amp;OSQ.STEG&amp;CSQ., &amp;OSQ.STEGOSAURUS&amp;CSQ. and &amp;OSQ.STEG.DATA&amp;CSQ. if they existed.
 
<p class="code"> %RC = $Lstr_Session_Del('ST??')
<li>To delete session longstrings named <code>STAN</code>, <code>STEP</code>, and <code>STUN.DATA</code>, if they existed:
<p class="code">%RC = $Lstr_Session_Del('ST??')
</p>
</p>
would delete session longstrings named &amp;OSQ.STAN&amp;CSQ., &amp;OSQ.STEP&amp;CSQ. and &amp;OSQ.STUN.DATA&amp;CSQ. if they existed.
 
<p class="code"> %RC = $Lstr_Global_Del('"**')
<li>To delete global longstrings named <code>*</code>, <code>*LOOK</code>, and <code>*ZAP.DATA</code>, if they existed:
<p class="code">%RC = $Lstr_Global_Del('"**')
</p>
</p>
would delete globals longstrings named &amp;OSQ.*&amp;CSQ., &amp;OSQ.*LOOK&amp;CSQ. and &amp;OSQ.*ZAP.DATA&amp;CSQ. if they existed.
 
<p class="code"> %RC = $Lstr_Session_Del('*')
<li>To delete all session longstrings:
<p class="code">%RC = $Lstr_Session_Del('*')
</p>
</p>
would delete all session longstrings.
</ol>


When a <var>$Lstr_Global_Del</var> or <var>$Lstr_Session_Del</var> is issued against a global or session longstring that is bound to a longstring in the current request, the longstring is unbound and its contents set to null. For example, after
==Usage notes==
<ul>
<li>When a <var>$Lstr_Global_Del</var> or <var>$Lstr_Session_Del</var> is issued against a global or session longstring that is bound to a longstring in the current request, the longstring is unbound and its contents set to null. For example, after the following sequence of statements the longstring <code>%dino</code> is set to null and is no longer bound to a global longstring:


<p class="code"> %RC = $Lstr_Global(%DINO, 'VELOCIRAPTOR')
<p class="code">%rc = $Lstr_Global(%dino, 'VELOCIRAPTOR')
%DINO = 'FLINTSTONES'
%dino = 'FLINTSTONES'
%RC = $Lstr_Global_Del('VEL*')
%rc = $Lstr_Global_Del('VEL*')
</p>
</p>
<p>
<var>$Lstr_Global_Del</var> does not distinguish among the manner in which a global longstring was created; it will delete any longstring created with <var>$Lstr_Global</var> or <var>$Lstr_Global_Set</var>. Similarly, <var>$Lstr_Session_Del</var> will delete any session longstring created either by <var>$Lstr_Session</var> or <var>$Lstr_Session_Set</var>. </p></li>


the longstring %DINO is set to null and is no longer bound to a global longstring. <var>$Lstr_Global_Del</var> does not distinguish among the manner in which a global longstring was created; it will delete any longstring created with <var>$Lstr_Global</var> or $Lstr_Global_Set. Similarly, <var>$Lstr_Session_Del</var> will delete any session longstring created either by <var>$Lstr_Session</var> or $Lstr_Session_Set.
<li>A <var>$Lstr_Session_Del</var> call when there is no session open causes a request cancellation. For more information about sessions, see [[Sessions]]. </li>
 
</ul>
A <var>$Lstr_Session_Del</var> call when there is no session open causes a request cancellation. For more information about sessions see [[Sessions|"Sessions"]].  


==Products authorizing $Lstr_Global_Del and $Lstr_Session_Del==
==Products authorizing $Lstr_Global_Del and $Lstr_Session_Del==


<ul class="smallAndTightList">
<ul class="smallAndTightList">
<li>[[Sirius functions]]</li>
<li>[[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>
   
   
[[Category:$Functions|$Lstr_Global_Del and $Lstr_Session_Del]]
[[Category:$Functions|$Lstr_Global_Del and $Lstr_Session_Del]]

Latest revision as of 16:09, 9 April 2018

$Lstr_Global_Del and $Lstr_Session_Del

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Lstr_Global_Del nor the $Lstr_Session_Del function.

These functions delete one or more global or session longstrings that were created with either $Lstr_Global_Set, $Lstr_Session_Set, $Lstr_Global, or $Lstr_Session in the current or any previous User Language program. It returns the number of deleted entries.

$Lstr_Global_Del and $Lstr_Session_Del accept one argument and return a numeric result.

Syntax

%rc = $Lstr_Global_Del(name)

%rc = $Lstr_Session_Del(name)

%rc Set to the number of deleted global or session Longstrings.
name A string that contains the name of the global or session Longstring that is to be deleted. This is a required argument and it cannot be a null string.

The name specified for $Lstr_Global_Del or $Lstr_Session_Del can be an explicit name or it can contain the following wildcard characters:

* Matches any number of characters including none.
? Matches any single character
" Indicates that the next character must be treated literally even if it is a wildcard character.

Examples

  1. To delete only a global longstring named TYRANNOSAURUS:

    %RC = $Lstr_Global_Del('TYRANNOSAURUS')

  2. To delete global longstrings named STEG, STEGOSAURUS,and STEG.DATA, if they existed:

    %RC = $Lstr_Global_Del('STEG*')

  3. To delete session longstrings named STAN, STEP, and STUN.DATA, if they existed:

    %RC = $Lstr_Session_Del('ST??')

  4. To delete global longstrings named *, *LOOK, and *ZAP.DATA, if they existed:

    %RC = $Lstr_Global_Del('"**')

  5. To delete all session longstrings:

    %RC = $Lstr_Session_Del('*')

Usage notes

  • When a $Lstr_Global_Del or $Lstr_Session_Del is issued against a global or session longstring that is bound to a longstring in the current request, the longstring is unbound and its contents set to null. For example, after the following sequence of statements the longstring %dino is set to null and is no longer bound to a global longstring:

    %rc = $Lstr_Global(%dino, 'VELOCIRAPTOR') %dino = 'FLINTSTONES' %rc = $Lstr_Global_Del('VEL*')

    $Lstr_Global_Del does not distinguish among the manner in which a global longstring was created; it will delete any longstring created with $Lstr_Global or $Lstr_Global_Set. Similarly, $Lstr_Session_Del will delete any session longstring created either by $Lstr_Session or $Lstr_Session_Set.

  • A $Lstr_Session_Del call when there is no session open causes a request cancellation. For more information about sessions, see Sessions.

Products authorizing $Lstr_Global_Del and $Lstr_Session_Del