List of $functions

These are the SOUL $functions available as of version 7.5 of Model 204. The $functions in the first table below (excepting the mathematical $functions) are available only with the purchase of the specified product.

Some $functions are deprecated in favor of an OO API method. When that is the case, the $function's page notes the matching method.

$Function set	Description
$xxxmath	Mathematical $functions
$Ftp_xxx	Janus FTP Server $functions
$Sock_xxx	Janus Sockets $functions
$Web_xxx	Janus Web Server $functions

$Function	Description
$A2E	Translate ASCII to EBCDIC
$Abbrev	Determine if string is abbreviation within list of words
$Arr_Find	Find value within array
$Arr_Init	Initialize every element of array to specific value
$Arr_Max	Find maximum value in array
$Arr_Min	Find minimum value in array
$Base64_Decode	Convert from base 64 to byte string
$Base64_Encode	Convert byte string to base 64
$BgPurge	Cancel "long" sdaemon request initiated with $CommBg
$BgQuery	List of "long" sdaemon requests initiated via $CommBg
$Bind	Fast, easy synchronization of system wide resource
$Bind_List	Return list of bound semaphores onto a $list
$BitAnd	Bitwise AND of two integers
$BitOr	Bitwise OR of two integers
$Bump	Bump a user
$C2D	Convert binary byte string to integer
$Center	Center string
$CfStatL	List of statistics for users holding critical file resources
$Close	Close file or group in User Language request
$Cms	Determine if online is running under CMS
$CommBg	Execute Model 204 commands on sdaemon
$Command	Execute Model 204 command on sdaemon, results to image
$CommndL	Execute Model 204 command on sdaemon, results to $list
$Context	Determine if string is name of open file or group
$D2C	Binary byte representation of integer
$D2X	Hex representation of integer
$DaemonMasterNumber	Get user number of master thread
$DaemonParentNumber	Get user number of parent thread
$Deflate	Compress a longstring with Deflate
$DelCh	Remove characters from string, compress and strip blanks
$Delg_Subsys	Delete subsystem-wide global
$Delg_Sys	Delete system-wide global
$Delimr	Insert delimiter string into input string at regular positions
$E2A	Translate EBCDIC to ASCII
$EdScan	Scan list of entities in online
$Ent	Do character entity substitution
$Ent_Print	Set automatic character entity substitution
$Ent_Tab	retrieve/modify character entity substitution table
$ErrSet	Increment or clear number of counting errors, set $ERRMSG
$FIniTim	File initialization YYDDDMMHHSSTH
$FakeEnt	Prepare fake ENTER to automatically satisfy next full screen read
$FiStat	Retrieve file's statistics into string
$FiStatL	Retrieve set of files' statistics into list
$Field_Image	Return field values into an image
$Field_List	Return field values into a $list
$Field_ListI	Return field values into a $list mapped to an image
$FreeOpt	Free optional file or group from subsystem
$FunForc	Cancel running or waiting Fast/Unload request
$FunImg	Retrieve data from active Fast/Unload request into image
$FunList	$list of active and enqueued Fast/Unload requests
$FunLoad	Fast/Unload records in Model 204 list or found set
$FunPurg	Purge running or waiting Fast/Unload request
$FunSkip	Skip to next output record for $FunImg, $FunsStr
$FunWait	Wait until asynchronous Fast/Unload request completes
$FunsStr	Retrieve data from active Fast/Unload request into string
$GZip	Compress a longstring with GZip
$GunZip	Decompress a longstring with GUNZIP
$HexA	Convert hexadecimal string to EBCDIC equivalent
$IHexA	Convert EBCDIC string to hexadecimal equivalent
$ImgInf	Retrieve image item by variable name
$ImgOvl	Replace image item value
$IncStat	Increment local system statistic
$Inflate	Decompress a longstring with inflate
$JobAuth	Determine if user has authorization for USE $JOB
$JpStat	Retrieve Janus port's statistics into string
$List_Add_Ordered	Add an item to an ordered $list
$List_Add_Unique	Conditionally add an item to a $list
$List_Add_Unique_Ordered	Conditionally add an item to an ordered $list
$List_Capture	Capture print data to $list
$List_Conv_Item	Convert $list to single delimited $list item
$List_Copy_Items	Copy items between $lists
$List_Diff_Item	Differences between $list and delimited $list item
$List_Global and $List_Session	Access/create global/session $list
$List_Global_Del and $List_Session_Del	Delete global/session $lists
$List_Global_List and $List_Session_List	List global/session $lists
$List_MaxIL	Return maximum $list item length
$List_Print	Display contents of a $list
$ListAdd	Add string as new $list item
$ListAdd_Lstr	Add longstring as new $list item
$ListAddI	Add image as new $list item
$ListAdj	Adjust length of $list item
$ListChk	Validate a $list identifier
$ListCmp	Compare two $lists and produce $list describing differences
$ListCnt	Number of items in $list
$ListCpy	Copy $list
$ListDel	Release CCATEMP storage used for $list
$ListFind	Find string in $list
$ListFindI and $ListFindI_Up	Find image item in $list
$ListFindI_Sub	Build $list subset based on image item
$ListILn	Length of $list item
$ListImg	Associate an image with a $list
$Listimg_Copy	Copy a $list's image association
$ListInf	Retrieve $list item into string
$ListInf_Lstr	Retrieve $list item into longstring
$ListInfI	Retrieve $list item into image
$ListIns	Insert string into a $list
$ListIns_Lstr	Insert string into a $list
$ListInsI	Insert image into a $list
$ListLoc	Locate string in $list
$ListLup	Locate string in $list, searching backwards
$ListMove	Move a $list
$ListNew	Create empty $list
$ListNewA	Create array of empty $lists
$ListNewAI	Create array of empty $lists associated with image
$ListNewI	Create empty $list associated with image
$ListOvl	Overlay part of $list item with string
$ListOvlI	Overlay part of $list item with image item
$ListRem	Remove item from $list
$ListRep	Replace a $list item with a string
$ListRep_Lstr	Replace a $list item with a longstring
$ListRepI	Replace $list item with an image
$ListRst	Restore global $list
$ListSav and $ListSave	Save global $list
$ListSavL	Count and names of available global $lists
$ListSort and $ListSrt	Sort $list
$ListSub	Create $list that is subset of input $list
$ListUpd	Produce $list from input $list using $list of updates
$Lstr	Treat a string as longstring
$Lstr_Add_UserBuffer	Add longstring to user buffer
$Lstr_Base64_Decode	Convert from base 64 to byte string
$Lstr_Base64_Encode	Convert byte string to base 64
$Lstr_C2X	Convert byte string to hexadecimal
$Lstr_Get_Image and $Lstr_Set_Image	Longstring to/from image
$Lstr_Get_Userbuffer	Get user buffer contents to a longstring
$Lstr_Global and $Lstr_Session	Bind to global/session longstring
$Lstr_Global_Del and $Lstr_Session_Del	Delete global or session longstring
$Lstr_Global_Get and $Lstr_Session_Get	Get global or session longstring
$Lstr_Global_Set and $Lstr_Session_Set	Set global or session longstring
$Lstr_Index	Find a string inside a longstring
$Lstr_Left	Leftmost characters of a longstring
$Lstr_Len	Length of a longstring
$Lstr_Parse	Part of longstring preceding character in delimiter set
$Lstr_ParseX	Part of longstring following character in delimiter set
$Lstr_Right	Rightmost characters of a longstring
$Lstr_Set_UserBuffer	Set user buffer to longstring value
$Lstr_Substr	Substring of a longstring
$Lstr_SubWord	Substring of a longstring using word counts
$Lstr_Translate	Translate longstring
$Lstr_Unblank	Remove extraneous blanks from longstring
$Lstr_Windex	Return the position of a word within a long string
$Lstr_Word	Return a word from a long string
$Lstr_Words	Return the number of words in a long string
$Lstr_X2C	Convert from hexadecimal to byte string
$Parse	Part of string preceding character in delimiter set
$ParseX	Part of string following character in delimiter set
$PrcLEx	$list of information about procedures in file
$PrcLExG	$list of information about procedures in group or file
$Priorty	Change a user's priority
$ProcCls	Close procedure before reaching end
$ProcDat	Add lines from procedure to $list
$ProcGet	Next line of procedure
$ProcLoc	Locate any of set of strings in procedure
$ProcOpn	Open procedure for $ProcDat, $ProcGet, $ProcLoc
$Proc_List	$list of information about procedures in file
$Proc_ListG	$list of information about procedures in group or file
$Proc_Touch	Change a procedure's last-update date and user
$Random	Get next random number
$Random_Seed	Build seed specifying series of $Random results
$RegexMatch	Whether string matches regex
$RegexReplace	Replace matching strings
$Resetn	Reset or view M204 parameter
$ScrHide	Hide lines in SCREEN
$ScrSize	Change size of field on SCREEN
$ScrWide	Allow SCREEN to accept fields wider than 79
$Session, $Session_Id, $Session_Owner,    and $Session_Timeout	Return values for currently open session
$Session_Close	Close an open session
$Session_Create	Create a new session
$Session_Delete	Delete a session
$Session_List	Get list of sessions
$Session_Open	Open a session
$SetStat	Set local system statistic
$Setg_Subsys	Set subsystem-wide global
$Setg_Subsys_List	Get list of subsystem-wide globals
$Setg_Sys	Set system-wide global
$Setg_Sys_List	Get list of system-wide globals
$SirJGet	Place audit trail data on $list
$SirMsg	Line of current $SirMsgP procedure
$SirMsgP	Load procedure for retrieval via $SirMsg
$SirParm	Set user-specific value, controlling Sirius products
$SirProd	Determine availability of Sirius product or capability
$SirSite	Current Sirius customer site ID
$SirTime	Current time as YYDDDHHMISSXX
$SirVer	Current version number of Sirius product
$SirWarn	Send warning or message to user(s)
$Sir_Date	Get current datetime
$Sir_Date2N	Convert datetime string to number of seconds/300
$Sir_Date2ND	Convert datetime string to number of days
$Sir_Date2NM	Convert datetime string to number of milliseconds
$Sir_Date2NS	Convert datetime string to number of seconds
$Sir_DateFmt	Validate datetime format
$Sir_DateN	Current date and time as number of seconds/300
$Sir_DateND	Current date as number of days
$Sir_DateNM	Current date and time as number of milliseconds
$Sir_DateNS	Current date and time as number of seconds
$Sir_Login	Perform secured web or sockets login
$Sir_N2Date	Convert datetime number of seconds/300 to string
$Sir_ND2Date	Convert datetime number of days to string
$Sir_NM2Date	Convert datetime number of milliseconds to string
$Sir_NS2Date	Convert datetime number of seconds to string
$Sir_Wild	Test string against a wildcard string
$SsStat	Retrieve subsystem's statistics into string
$SsStatL	Retrieve statistics for set of subsystems into $list
$StatD	Calculate differences and rates for statistics strings
$StatLD	Calculate differences and rates for statistics $lists
$Str	Treat a longstring as string
$StrAnd	Bit-wise AND two strings
$StrOr	Bit-wise OR two strings
$StrXor	Bit-wise exclusive OR two strings
$SubCnt	Count occurrences of one string in another
$SubErs	Remove occurrence of one string from another
$SubIns	Insert string inside another string
$SubRep	Replace occurrences of string
$SyStat	Retrieve system statistics into string
$TableC	Information provided by TABLEC command
$TermId	Terminal ID of current user thread
$TkStat	Retrieve task's statistics into string
$TkStatL	Retrieve statistics for all tasks into $list
$TsoAtt	Attach program in user's TSO address space
$TsoCall	Call program in user's TSO address space
$TsoCan	Cancel program invoked via $TsoAtt
$TsoCmd	Invoke command in user's TSO address space
$TsoExec	Invoke CLIST in user's TSO address space
$TsoExit	Terminate TSO full screen interface session, stack command
$TSOId	TSO userid user's thread
$TSOStat	Status of program invoked via $TsoAtt
$TSOWait	Wait for program invoked via $TsoAtt to complete
$UnSpace	Normalize spaces and quotes
$Unbind_and_$UnbindW	$Unbind and $UnbindW: Unbind resource previously bound via $Bind
$UsStat	Retrieve user's statistics into string
$UsStatL	Retrieve statistics for set of users into $list
$UseASA	Prevent carriage control in USE output
$WakeUp	Pause user until specified time
$Web_xxx	List of Janus Web Server $functions
$Windex	Word number of first occurrence of word in phrase
$X2D	Convert hex string to integer