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

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />and $Lstr_Session_Del<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />and $Lstr_Session_Del<section end="desc" /></span>


<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Global_Del and $Lstr_Session_Del function is [[to be entered]].</p>
<p class="warning">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>


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.  
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.  
Line 9: Line 9:


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.
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"><section begin="syntax" /> %RC = $Lstr_Global_Del(name)
<p class="syntax"><section begin="syntax" /> %RC = $Lstr_Global_Del(name)
Line 24: Line 25:


The name specified for $Lstr_Global_Del or $Lstr_Session_Del can be an explicit name or it can contain the following wildcard characters:
The name specified for $Lstr_Global_Del or $Lstr_Session_Del can be an explicit name or it can contain the following wildcard characters:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>*</th>
<tr><th>*</th>
Line 50: Line 52:


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
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
<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>
the longstring %DINO is set to null and is no longer bound to a global longstring. $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.  
the longstring %DINO is set to null and is no longer bound to a global longstring. $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.  


Revision as of 21:36, 10 February 2011

<section begin="desc" />and $Lstr_Session_Del<section end="desc" />

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.

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.

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

<section begin="syntax" /> %RC = $Lstr_Global_Del(name) <section end="syntax" />

$Lstr_Global_Del Function

%RC is set to number of deleted global longstrings.

%RC = $Lstr_Session_Del(name)

$Lstr_Session_Del Function

%RC is set to the number of deleted session longstrings.


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.

For example,

%RC = $Lstr_Global_Del('TYRANNOSAURUS')

would only delete a global longstring named &OSQ.TYRANNOSAURUS&CSQ..

%RC = $Lstr_Global_Del('STEG*')

would delete globals longstrings named &OSQ.STEG&CSQ., &OSQ.STEGOSAURUS&CSQ. and &OSQ.STEG.DATA&CSQ. if they existed.

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

would delete session longstrings named &OSQ.STAN&CSQ., &OSQ.STEP&CSQ. and &OSQ.STUN.DATA&CSQ. if they existed.

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

would delete globals longstrings named &OSQ.*&CSQ., &OSQ.*LOOK&CSQ. and &OSQ.*ZAP.DATA&CSQ. if they existed.

%RC = $Lstr_Session_Del('*')

would delete all session longstrings.

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

%RC = $Lstr_Global(%DINO, 'VELOCIRAPTOR') %DINO = 'FLINTSTONES' %RC = $Lstr_Global_Del('VEL*')

the longstring %DINO is set to null and is no longer bound to a global longstring. $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 :hdref refid=ses..

$Lstr_Global_Del and $Lstr_Session_Del are new in Version 6.3 of the Sirius Mods.

Products authorizing $Lstr_Global_Del and $Lstr_Session_Del

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=$Lstr_Global_Del_and_$Lstr_Session_Del&oldid=34981"