List of $functions

From m204wiki
Revision as of 12:30, 8 February 2011 by Wiccan (talk | contribs) (Automatically generated page update)
Jump to navigation Jump to search

The following are the available Sirius $functions.

See Notation conventions for methods for information about the conventions followed in the method descriptions.

$FunctionDescription
$A2ETranslate ASCII to EBCDIC
$AbbrevDetermine if string is abbreviation within list of words
$Arr FindFind value within array
$Arr InitInitialize every element of array to specific value
$Arr MaxFind maximum value in array
$Arr MinFind minimum value in array
$Base64 DecodeConvert from base 64 to byte string
$Base64 EncodeConvert byte string to base 64
$BgPurgeCancel "long" sdaemon request initiated with $CommBg
$BgQueryList of "long" sdaemon requests initiated via $CommBg
$BindFast, easy synchronization of system wide resource
$Bind ListReturn list of bound semaphores onto a $list
$BitAndBitwise AND of two integers
$BitOrBitwise OR of two integers
$BumpBump a user
$C2DConvert binary byte string to integer
$CenterCenter string
$CfStatLList of statistics for users holding critical file resources
$CloseClose file or group in User Language request
$CmsDetermine if online is running under CMS
$CommBgExecute Model 204 commands on sdaemon
$CommandExecute Model 204 command on sdaemon, results to image
$CommndLExecute Model 204 command on sdaemon, results to $list
$ContextDetermine if string is name of open file or group
$D2CBinary byte representation of integer
$D2XHex representation of integer
$DaemonMasterNumberGet user number of master thread
$DaemonParentNumberGet user number of parent thread
$DeflateCompress a longstring with Deflate
$DelChRemove characters from string, compress and strip blanks
$Delg SubsysDelete subsystem-wide global
$Delg SysDelete system-wide global
$DelimrInsert delimiter string into input string at regular positions
$E2ATranslate EBCDIC to ASCII
$EdScanScan list of entities in online
$EntDo character entity substitution
$Ent PrintSet automatic character entity substitution
$Ent Tabretrieve/modify character entity substitution table
$ErrSetIncrement or clear number of counting errors, set $ERRMSG
$FIniTimFile initialization YYDDDMMHHSSTH
$FakeEntPrepare fake ENTER to automatically satisfy next full screen read
$FiStatRetrieve file's statistics into string
$FiStatLRetrieve set of files' statistics into list
$Field ImageReturn field values into an image
$Field ListReturn field values into a $list
$Field ListIReturn field values into a $list mapped to an image
$FreeOptFree optional file or group from subsystem
$FunForcCancel running or waiting Fast/Unload request
$FunImgRetrieve data from active Fast/Unload request into image
$FunList$list of active and enqueued Fast/Unload requests
$FunLoadFast/Unload records in Model 204 list or found set
$FunPurgPurge running or waiting Fast/Unload request
$FunSkipSkip to next output record for $FunImg, $FunsStr
$FunWaitWait until asynchronous Fast/Unload request completes
$FunsStrRetrieve data from active Fast/Unload request into string
$GZipCompress a longstring with GZip
$GunZipDecompress a longstring with GUNZIP
$HexAConvert hexadecimal string to EBCDIC equivalent
$IHexAConvert EBCDIC string to hexadecimal equivalent
$ImgInfRetrieve image item by variable name
$ImgOvlReplace image item value
$IncStatIncrement local system statistic
$InflateDecompress a longstring with inflate
$JobAuthDetermine if user has authorization for USE $JOB
$ParsePart of string preceding character in delimiter set
$ParseXPart 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
$PriortyChange a user's priority
$ProcClsClose procedure before reaching end
$ProcDatAdd lines from procedure to $list
$ProcGetNext line of procedure
$ProcLocLocate any of set of strings in procedure
$ProcOpnOpen 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 TouchChange a procedure's last-update date and user
$RandomGet next random number
$Random SEEDBuild seed specifying series of $RANDOM results
$RegexMatchWhether string matches regex
$RegexReplaceReplace matching strings
$ResetnReset or view M204 parameter
$Session $Session Id $Session Owner and $Session Timeout$Session_Id, $Session_Owner and $Session_Timeout
$Session CloseClose an open session
$Session CreateCreate a new session
$Session DeleteDelete a session
$Session ListGet list of sessions
$Session OpenOpen a session
$SetStatSet local system statistic
$Setg SubsysSet subsystem-wide global
$Setg Subsys ListGet list of subsystem-wide globals
$Setg SysSet system-wide global
$Setg Sys ListGet list of system-wide globals
$SirJGetPlace audit trail data on $list
$SirMsgLine of current $SirMsgP procedure
$SirMsgPLoad procedure for retrieval via $SirMsg
$SirParmSet user-specific value, controlling Sirius products
$SirProdDetermine availability of Sirius product or capability
$SirSiteCurrent Sirius customer site ID
$SirTimeCurrent time as YYDDDHHMISSXX
$SirVerCurrent version number of Sirius product
$SirWarnSend warning or message to user(s)
$Sir DateGet current datetime
$Sir Date2NConvert datetime string to number of seconds/300
$Sir Date2NDConvert datetime string to number of days
$Sir Date2NMConvert datetime string to number of milliseconds
$Sir Date2NSConvert datetime string to number of seconds
$Sir DateFmtValidate datetime format
$Sir DateNCurrent date and time as number of seconds/300
$Sir DateNDCurrent date as number of days
$Sir DateNMCurrent date and time as number of milliseconds
$Sir DateNSCurrent date and time as number of seconds
$Sir N2DateConvert datetime number of seconds/300 to string
$Sir ND2DateConvert datetime number of days to string
$Sir NM2DateConvert datetime number of milliseconds to string
$Sir NS2DateConvert datetime number of seconds to string
$Sir WildTest string against a wildcard string
$SsStatRetrieve subsystem's statistics into string
$SsStatLRetrieve statistics for set of subsystems into $list
$StatDCalculate differences and rates for statistics strings
$StatLDCalculate differences and rates for statistics $lists
$StrTreat a longstring as string
$StrAndBit-wise AND two strings
$StrOrBit-wise OR two strings
$StrXorBit-wise exclusive OR two strings
$SubCntCount occurrences of one string in another
$SubErsRemove occurrence of one string from another
$SubInsInsert string inside another string
$SubRepReplace occurrences of string
$SyStatRetrieve system statistics into string
$TSOIdTSO userid user's thread
$TSOStatStatus of program invoked via $TsoAtt
$TSOWaitWait for program invoked via $TsoAtt to complete
$TableCInformation provided by TABLEC command
$TermIdTerminal ID of current user thread
$TkStatRetrieve task's statistics into string
$TkStatLRetrieve statistics for all tasks into $list
$TsoAttAttach program in user's TSO address space
$TsoCallCall program in user's TSO address space
$TsoCanCancel program invoked via $TsoAtt
$TsoCmdInvoke command in user's TSO address space
$TsoExecInvoke CLIST in user's TSO address space
$TsoExitTerminate TSO full screen interface session, stack command
$UnSpaceNormalize spaces and quotes
$Unbind and $UnbindW$Unbind and $UnbindW: Unbind resource previously bound via $Bind
$UsStatRetrieve user's statistics into string
$UsStatLRetrieve statistics for set of users into $list
$UseASAPrevent carriage control in USE output
$WakeUpPause user until specified time
$WindexWord number of first occurrence of word in phrase
$X2DConvert hex string to integer