$Lstr Global Del and $Lstr Session Del

$Lstr_Global_Del and $Lstr_Session_Del

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 "Sessions".

• Sirius functions
• Fast/Unload User Language Interface
• Janus Open Client
• Janus Open Server
• Janus Sockets
• Janus Web Server
• Japanese functions
• Sir2000 Field Migration Facility

Products authorizing $Lstr_Global_Del and $Lstr_Session_Del