|
|
| (40 intermediate revisions by 5 users not shown) |
| Line 1: |
Line 1: |
| <div class="showVisit">
| | #REDIRECT[[SOUL $functions#List of standard $functions]] |
| | |
| The following are the available [[$Functions|Sirius $functions]].
| |
| | |
| See [[Notation conventions for methods]] for information about the conventions followed in the method descriptions.
| |
| | |
| <table class="wikitable">
| |
| <tr><th>$Function</th><th>Description</th></tr>
| |
| <tr><td>[[$A2E]]</td><td>Translate ASCII to EBCDIC</td></tr>
| |
| <tr><td>[[$Abbrev]]</td><td>Determine if string is abbreviation within list of words</td></tr>
| |
| <tr><td>[[$Arr_Find]]</td><td>Find value within array</td></tr>
| |
| <tr><td>[[$Arr_Init]]</td><td>Initialize every element of array to specific value</td></tr>
| |
| <tr><td>[[$Arr_Max]]</td><td>Find maximum value in array</td></tr>
| |
| <tr><td>[[$Arr_Min]]</td><td>Find minimum value in array</td></tr>
| |
| <tr><td>[[$Base64_Decode]]</td><td>Convert from base 64 to byte string</td></tr>
| |
| <tr><td>[[$Base64_Encode]]</td><td>Convert byte string to base 64</td></tr>
| |
| <tr><td>[[$BgPurge]]</td><td>Cancel "long" sdaemon request initiated with $CommBg</td></tr>
| |
| <tr><td>[[$BgQuery]]</td><td>List of "long" sdaemon requests initiated via $CommBg</td></tr>
| |
| <tr><td>[[$Bind]]</td><td>Fast, easy synchronization of system wide resource</td></tr>
| |
| <tr><td>[[$Bind_List]]</td><td>Return list of bound semaphores onto a $list</td></tr>
| |
| <tr><td>[[$BitAnd]]</td><td>Bitwise AND of two integers</td></tr>
| |
| <tr><td>[[$BitOr]]</td><td>Bitwise OR of two integers</td></tr>
| |
| <tr><td>[[$Bump]]</td><td>Bump a user</td></tr>
| |
| <tr><td>[[$C2D]]</td><td>Convert binary byte string to integer</td></tr>
| |
| <tr><td>[[$Center]]</td><td>Center string</td></tr>
| |
| <tr><td>[[$CfStatL]]</td><td>List of statistics for users holding critical file resources</td></tr>
| |
| <tr><td>[[$Close]]</td><td>Close file or group in User Language request</td></tr>
| |
| <tr><td>[[$Cms]]</td><td>Determine if online is running under CMS</td></tr>
| |
| <tr><td>[[$CommBg]]</td><td>Execute Model 204 commands on sdaemon</td></tr>
| |
| <tr><td>[[$Command]]</td><td>Execute Model 204 command on sdaemon, results to image</td></tr>
| |
| <tr><td>[[$CommndL]]</td><td>Execute Model 204 command on sdaemon, results to $list</td></tr>
| |
| <tr><td>[[$Context]]</td><td>Determine if string is name of open file or group</td></tr>
| |
| <tr><td>[[$D2C]]</td><td>Binary byte representation of integer</td></tr>
| |
| <tr><td>[[$D2X]]</td><td>Hex representation of integer</td></tr>
| |
| <tr><td>[[$DaemonMasterNumber]]</td><td>Get user number of master thread</td></tr>
| |
| <tr><td>[[$DaemonParentNumber]]</td><td>Get user number of parent thread</td></tr>
| |
| <tr><td>[[$Deflate]]</td><td>Compress a longstring with Deflate</td></tr>
| |
| <tr><td>[[$DelCh]]</td><td>Remove characters from string, compress and strip blanks</td></tr>
| |
| <tr><td>[[$Delg_Subsys]]</td><td>Delete subsystem-wide global</td></tr>
| |
| <tr><td>[[$Delg_Sys]]</td><td>Delete system-wide global</td></tr>
| |
| <tr><td>[[$Delimr]]</td><td>Insert delimiter string into input string at regular positions</td></tr>
| |
| <tr><td>[[$E2A]]</td><td>Translate EBCDIC to ASCII</td></tr>
| |
| <tr><td>[[$EdScan]]</td><td>Scan list of entities in online</td></tr>
| |
| <tr><td>[[$Ent]]</td><td>Do character entity substitution</td></tr>
| |
| <tr><td>[[$Ent_Print]]</td><td>Set automatic character entity substitution</td></tr>
| |
| <tr><td>[[$Ent_Tab]]</td><td>retrieve/modify character entity substitution table</td></tr>
| |
| <tr><td>[[$ErrSet]]</td><td>Increment or clear number of counting errors, set $ERRMSG</td></tr>
| |
| <tr><td>[[$FIniTim]]</td><td>File initialization YYDDDMMHHSSTH</td></tr>
| |
| <tr><td>[[$FakeEnt]]</td><td>Prepare fake ENTER to automatically satisfy next full screen read</td></tr>
| |
| <tr><td>[[$FiStat]]</td><td>Retrieve file's statistics into string</td></tr>
| |
| <tr><td>[[$FiStatL]]</td><td>Retrieve set of files' statistics into list</td></tr>
| |
| <tr><td>[[$Field_Image]]</td><td>Return field values into an image</td></tr>
| |
| <tr><td>[[$Field_List]]</td><td>Return field values into a $list</td></tr>
| |
| <tr><td>[[$Field_ListI]]</td><td>Return field values into a $list mapped to an image</td></tr>
| |
| <tr><td>[[$FreeOpt]]</td><td>Free optional file or group from subsystem</td></tr>
| |
| <tr><td>[[$FunForc]]</td><td>Cancel running or waiting Fast/Unload request</td></tr>
| |
| <tr><td>[[$FunImg]]</td><td>Retrieve data from active Fast/Unload request into image</td></tr>
| |
| <tr><td>[[$FunList]]</td><td>$list of active and enqueued Fast/Unload requests</td></tr>
| |
| <tr><td>[[$FunLoad]]</td><td>Fast/Unload records in Model 204 list or found set</td></tr>
| |
| <tr><td>[[$FunPurg]]</td><td>Purge running or waiting Fast/Unload request</td></tr>
| |
| <tr><td>[[$FunSkip]]</td><td>Skip to next output record for $FunImg, $FunsStr</td></tr>
| |
| <tr><td>[[$FunWait]]</td><td>Wait until asynchronous Fast/Unload request completes</td></tr>
| |
| <tr><td>[[$FunsStr]]</td><td>Retrieve data from active Fast/Unload request into string</td></tr>
| |
| <tr><td>[[$GZip]]</td><td>Compress a longstring with GZip</td></tr>
| |
| <tr><td>[[$GunZip]]</td><td>Decompress a longstring with GUNZIP</td></tr>
| |
| <tr><td>[[$HexA]]</td><td>Convert hexadecimal string to EBCDIC equivalent</td></tr>
| |
| <tr><td>[[$IHexA]]</td><td>Convert EBCDIC string to hexadecimal equivalent</td></tr>
| |
| <tr><td>[[$ImgInf]]</td><td>Retrieve image item by variable name</td></tr>
| |
| <tr><td>[[$ImgOvl]]</td><td>Replace image item value</td></tr>
| |
| <tr><td>[[$IncStat]]</td><td>Increment local system statistic</td></tr>
| |
| <tr><td>[[$Inflate]]</td><td>Decompress a longstring with inflate</td></tr>
| |
| <tr><td>[[$JobAuth]]</td><td>Determine if user has authorization for USE $JOB</td></tr>
| |
| <tr><td>[[$Parse]]</td><td>Part of string preceding character in delimiter set</td></tr>
| |
| <tr><td>[[$ParseX]]</td><td>Part of string following character in delimiter set</td></tr>
| |
| <tr><td>[[$PrcLEx]]</td><td>$list of information about procedures in file</td></tr>
| |
| <tr><td>[[$PrcLExG]]</td><td>$list of information about procedures in group or file</td></tr>
| |
| <tr><td>[[$Priorty]]</td><td>Change a user's priority</td></tr>
| |
| <tr><td>[[$ProcCls]]</td><td>Close procedure before reaching end</td></tr>
| |
| <tr><td>[[$ProcDat]]</td><td>Add lines from procedure to $list</td></tr>
| |
| <tr><td>[[$ProcGet]]</td><td>Next line of procedure</td></tr>
| |
| <tr><td>[[$ProcLoc]]</td><td>Locate any of set of strings in procedure</td></tr>
| |
| <tr><td>[[$ProcOpn]]</td><td>Open procedure for $ProcDat, $ProcGet, $ProcLoc</td></tr>
| |
| <tr><td>[[$Proc_List]]</td><td>$list of information about procedures in file</td></tr>
| |
| <tr><td>[[$Proc_ListG]]</td><td>$list of information about procedures in group or file</td></tr>
| |
| <tr><td>[[$Proc_Touch]]</td><td>Change a procedure's last-update date and user</td></tr>
| |
| <tr><td>[[$Random]]</td><td>Get next random number</td></tr>
| |
| <tr><td>[[$Random_SEED]]</td><td>Build seed specifying series of $RANDOM results</td></tr>
| |
| <tr><td>[[$RegexMatch]]</td><td>Whether string matches regex</td></tr>
| |
| <tr><td>[[$RegexReplace]]</td><td>Replace matching strings</td></tr>
| |
| <tr><td>[[$Resetn]]</td><td>Reset or view M204 parameter</td></tr>
| |
| <tr><td>[[$Session_$Session_Id_$Session_Owner_and_$Session_Timeout]]</td><td>$Session_Id, $Session_Owner and $Session_Timeout</td></tr>
| |
| <tr><td>[[$Session_Close]]</td><td>Close an open session</td></tr>
| |
| <tr><td>[[$Session_Create]]</td><td>Create a new session</td></tr>
| |
| <tr><td>[[$Session_Delete]]</td><td>Delete a session</td></tr>
| |
| <tr><td>[[$Session_List]]</td><td>Get list of sessions</td></tr>
| |
| <tr><td>[[$Session_Open]]</td><td>Open a session</td></tr>
| |
| <tr><td>[[$SetStat]]</td><td>Set local system statistic</td></tr>
| |
| <tr><td>[[$Setg_Subsys]]</td><td>Set subsystem-wide global</td></tr>
| |
| <tr><td>[[$Setg_Subsys_List]]</td><td>Get list of subsystem-wide globals</td></tr>
| |
| <tr><td>[[$Setg_Sys]]</td><td>Set system-wide global</td></tr>
| |
| <tr><td>[[$Setg_Sys_List]]</td><td>Get list of system-wide globals</td></tr>
| |
| <tr><td>[[$SirJGet]]</td><td>Place audit trail data on $list</td></tr>
| |
| <tr><td>[[$SirMsg]]</td><td>Line of current $SirMsgP procedure</td></tr>
| |
| <tr><td>[[$SirMsgP]]</td><td>Load procedure for retrieval via $SirMsg</td></tr>
| |
| <tr><td>[[$SirParm]]</td><td>Set user-specific value, controlling Sirius products</td></tr>
| |
| <tr><td>[[$SirProd]]</td><td>Determine availability of Sirius product or capability</td></tr>
| |
| <tr><td>[[$SirSite]]</td><td>Current Sirius customer site ID</td></tr>
| |
| <tr><td>[[$SirTime]]</td><td>Current time as YYDDDHHMISSXX</td></tr>
| |
| <tr><td>[[$SirVer]]</td><td>Current version number of Sirius product</td></tr>
| |
| <tr><td>[[$SirWarn]]</td><td>Send warning or message to user(s)</td></tr>
| |
| <tr><td>[[$Sir_Date]]</td><td>Get current datetime</td></tr>
| |
| <tr><td>[[$Sir_Date2N]]</td><td>Convert datetime string to number of seconds/300</td></tr>
| |
| <tr><td>[[$Sir_Date2ND]]</td><td>Convert datetime string to number of days</td></tr>
| |
| <tr><td>[[$Sir_Date2NM]]</td><td>Convert datetime string to number of milliseconds</td></tr>
| |
| <tr><td>[[$Sir_Date2NS]]</td><td>Convert datetime string to number of seconds</td></tr>
| |
| <tr><td>[[$Sir_DateFmt]]</td><td>Validate datetime format</td></tr>
| |
| <tr><td>[[$Sir_DateN]]</td><td>Current date and time as number of seconds/300</td></tr>
| |
| <tr><td>[[$Sir_DateND]]</td><td>Current date as number of days</td></tr>
| |
| <tr><td>[[$Sir_DateNM]]</td><td>Current date and time as number of milliseconds</td></tr>
| |
| <tr><td>[[$Sir_DateNS]]</td><td>Current date and time as number of seconds</td></tr>
| |
| <tr><td>[[$Sir_N2Date]]</td><td>Convert datetime number of seconds/300 to string</td></tr>
| |
| <tr><td>[[$Sir_ND2Date]]</td><td>Convert datetime number of days to string</td></tr>
| |
| <tr><td>[[$Sir_NM2Date]]</td><td>Convert datetime number of milliseconds to string</td></tr>
| |
| <tr><td>[[$Sir_NS2Date]]</td><td>Convert datetime number of seconds to string</td></tr>
| |
| <tr><td>[[$Sir_Wild]]</td><td>Test string against a wildcard string</td></tr>
| |
| <tr><td>[[$SsStat]]</td><td>Retrieve subsystem's statistics into string</td></tr>
| |
| <tr><td>[[$SsStatL]]</td><td>Retrieve statistics for set of subsystems into $list</td></tr>
| |
| <tr><td>[[$StatD]]</td><td>Calculate differences and rates for statistics strings</td></tr>
| |
| <tr><td>[[$StatLD]]</td><td>Calculate differences and rates for statistics $lists</td></tr>
| |
| <tr><td>[[$Str]]</td><td>Treat a longstring as string</td></tr>
| |
| <tr><td>[[$StrAnd]]</td><td>Bit-wise AND two strings</td></tr>
| |
| <tr><td>[[$StrOr]]</td><td>Bit-wise OR two strings</td></tr>
| |
| <tr><td>[[$StrXor]]</td><td>Bit-wise exclusive OR two strings</td></tr>
| |
| <tr><td>[[$SubCnt]]</td><td>Count occurrences of one string in another</td></tr>
| |
| <tr><td>[[$SubErs]]</td><td>Remove occurrence of one string from another</td></tr>
| |
| <tr><td>[[$SubIns]]</td><td>Insert string inside another string</td></tr>
| |
| <tr><td>[[$SubRep]]</td><td>Replace occurrences of string</td></tr>
| |
| <tr><td>[[$SyStat]]</td><td>Retrieve system statistics into string</td></tr>
| |
| <tr><td>[[$TSOId]]</td><td>TSO userid user's thread</td></tr>
| |
| <tr><td>[[$TSOStat]]</td><td>Status of program invoked via $TsoAtt</td></tr>
| |
| <tr><td>[[$TSOWait]]</td><td>Wait for program invoked via $TsoAtt to complete</td></tr>
| |
| <tr><td>[[$TableC]]</td><td>Information provided by TABLEC command</td></tr>
| |
| <tr><td>[[$TermId]]</td><td>Terminal ID of current user thread</td></tr>
| |
| <tr><td>[[$TkStat]]</td><td>Retrieve task's statistics into string</td></tr>
| |
| <tr><td>[[$TkStatL]]</td><td>Retrieve statistics for all tasks into $list</td></tr>
| |
| <tr><td>[[$TsoAtt]]</td><td>Attach program in user's TSO address space</td></tr>
| |
| <tr><td>[[$TsoCall]]</td><td>Call program in user's TSO address space</td></tr>
| |
| <tr><td>[[$TsoCan]]</td><td>Cancel program invoked via $TsoAtt</td></tr>
| |
| <tr><td>[[$TsoCmd]]</td><td>Invoke command in user's TSO address space</td></tr>
| |
| <tr><td>[[$TsoExec]]</td><td>Invoke CLIST in user's TSO address space</td></tr>
| |
| <tr><td>[[$TsoExit]]</td><td>Terminate TSO full screen interface session, stack command</td></tr>
| |
| <tr><td>[[$UnSpace]]</td><td>Normalize spaces and quotes</td></tr>
| |
| <tr><td>[[$Unbind_and_$UnbindW]]</td><td>$Unbind and $UnbindW: Unbind resource previously bound via $Bind</td></tr>
| |
| <tr><td>[[$UsStat]]</td><td>Retrieve user's statistics into string</td></tr>
| |
| <tr><td>[[$UsStatL]]</td><td>Retrieve statistics for set of users into $list</td></tr>
| |
| <tr><td>[[$UseASA]]</td><td>Prevent carriage control in USE output</td></tr>
| |
| <tr><td>[[$WakeUp]]</td><td>Pause user until specified time</td></tr>
| |
| <tr><td>[[$Windex]]</td><td>Word number of first occurrence of word in phrase</td></tr>
| |
| <tr><td>[[$X2D]]</td><td>Convert hex string to integer</td></tr>
| |
| </table>
| |
| </div>
| |