List of $functions: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<div class="showVisit">
<div class="showVisit">


These are the $functions written by Sirius Software which are not part of a product set (like the $Web functions which are part of <var class="product">Janus Web Server</var>, or the $Sock functions which are one API for <var class="product">Janus Sockets</var>). Many of these functions are deprecated in favor of an OO API method. Matching OO methods are noted on each $function page.
These are the $functions written by Sirius Software. Many of these functions are deprecated in favor of an OO API method. Matching OO methods are noted on each $function page.


A more compact listing of these $functions, which omits their descriptions, is also [[:Category:$Functions|available]].
Some $functions that are part of a Sirius product are listed only within that product's $function listing. Those product sets are listed in the first table, below. 
 
<table class="wikitable">
<tr><th>$Function set</th><th>Description</th></tr>
<tr><td>[[List of mathematical $functions|$nnn(args)]]</td><td>Mathematical $functions</td></tr>
<tr><td>[[List of Fast/Unload $functions|$Funxxx]]</td><td>Fast/Unload User Language Interface $functions</td></tr>
<tr><td>[[List of Janus Sockets $functions|$Sock_xxx]]</td><td>Janus Sockets $functions</td></tr>
<tr><td>[[List of Janus Web Server $functions|$Web_xxx]]</td><td>Janus Web Server $functions</td></tr>
</table>


<table class="wikitable">
<table class="wikitable">
Line 216: Line 224:
<tr><td>[[$SubRep]]</td><td>Replace occurrences of 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>[[$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>[[$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>[[$TermId]]</td><td>Terminal ID of current user thread</td></tr>
Line 229: Line 234:
<tr><td>[[$TsoExec]]</td><td>Invoke CLIST 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>[[$TsoExit]]</td><td>Terminate TSO full screen interface session, stack command</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>[[$UnSpace]]</td><td>Normalize spaces and quotes</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>[[$Unbind_and_$UnbindW]]</td><td>$Unbind and $UnbindW: Unbind resource previously bound via $Bind</td></tr>

Revision as of 01:53, 20 December 2011

These are the $functions written by Sirius Software. Many of these functions are deprecated in favor of an OO API method. Matching OO methods are noted on each $function page.

Some $functions that are part of a Sirius product are listed only within that product's $function listing. Those product sets are listed in the first table, below.

$Function setDescription
$nnn(args)Mathematical $functions
$FunxxxFast/Unload User Language Interface $functions
$Sock_xxxJanus Sockets $functions
$Web_xxxJanus Web Server $functions
$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
$List_Add_OrderedAdd an item to an ordered $list
$List_Add_UniqueConditionally add an item to a $list
$List_Add_Unique_OrderedConditionally add an item to an ordered $list
$List_CaptureCapture print data to $list
$List_Conv_ItemConvert $list to single delimited $list item
$List_Copy_ItemsCopy items between $lists
$List_Diff_ItemDifferences between $list and delimited $list item
$List_Global and $List_SessionAccess/create global/session $list
$List_Global_Del and $List_Session_DelDelete global/session $lists
$List_Global_List and $List_Session_ListList global/session $lists
$List_MaxILReturn maximum $list item length
$List_PrintDisplay contents of a $list
$ListAddAdd string as new $list item
$ListAdd_LstrAdd longstring as new $list item
$ListAddIAdd image as new $list item
$ListAdjAdjust length of $list item
$ListChkValidate a $list identifier
$ListCmpCompare two $lists and produce $list describing differences
$ListCntNumber of items in $list
$ListCpyCopy $list
$ListDelRelease CCATEMP storage used for $list
$ListFindFind string in $list
$ListFindI and $ListFindI_UpFind image item in $list
$ListFindI_SubBuild $list subset based on image item
$ListILnLength of $list item
$ListImgAssociate an image with a $list
$Listimg_CopyCopy a $list's image association
$ListInfRetrieve $list item into string
$ListInf_LstrRetrieve $list item into longstring
$ListInfIRetrieve $list item into image
$ListInsInsert string into a $list
$ListIns_LstrInsert string into a $list
$ListInsIInsert image into a $list
$ListLocLocate string in $list
$ListLupLocate string in $list, searching backwards
$ListMoveMove a $list
$ListNewCreate empty $list
$ListNewACreate array of empty $lists
$ListNewAICreate array of empty $lists associated with image
$ListNewICreate empty $list associated with image
$ListOvlOverlay part of $list item with string
$ListOvlIOverlay part of $list item with image item
$ListRemRemove item from $list
$ListRepReplace a $list item with a string
$ListRep_LstrReplace a $list item with a longstring
$ListRepIReplace $list item with an image
$ListRstRestore global $list
$ListSav and $ListSaveSave global $list
$ListSavLCount and names of available global $lists
$ListSort and $ListSrtSort $list
$ListSubCreate $list that is subset of input $list
$ListUpdProduce $list from input $list using $list of updates
$LstrTreat a string as longstring
$Lstr_Add_UserBufferAdd longstring to user buffer
$Lstr_Base64_DecodeConvert from base 64 to byte string
$Lstr_Base64_EncodeConvert byte string to base 64
$Lstr_C2XConvert byte string to hexadecimal
$Lstr_Get_Image and $Lstr_Set_ImageLongstring to/from image
$Lstr_Get_UserbufferGet user buffer contents to a longstring
$Lstr_Global and $Lstr_SessionBind to global/session longstring
$Lstr_Global_Del and $Lstr_Session_DelDelete global or session longstring
$Lstr_Global_Get and $Lstr_Session_GetGet global or session longstring
$Lstr_Global_Set and $Lstr_Session_SetSet global or session longstring
$Lstr_IndexFind a string inside a longstring
$Lstr_LeftLeftmost characters of a longstring
$Lstr_LenLength of a longstring
$Lstr_ParsePart of longstring preceding character in delimiter set
$Lstr_ParseXPart of longstring following character in delimiter set
$Lstr_RightRightmost characters of a longstring
$Lstr_Set_UserBufferSet user buffer to longstring value
$Lstr_SubstrSubstring of a longstring
$Lstr_SubWordSubstring of a longstring using word counts
$Lstr_TranslateTranslate longstring
$Lstr_UnblankRemove extraneous blanks from longstring
$Lstr_WindexReturn the position of a word within a long string
$Lstr_WordReturn a word from a long string
$Lstr_WordsReturn the number of words in a long string
$Lstr_X2CConvert from hexadecimal to byte string
$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
Return values for currently open session
$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_LoginPerform secured web or sockets login
$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
$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
$TSOIdTSO userid user's thread
$TSOStatStatus of program invoked via $TsoAtt
$TSOWaitWait for program invoked via $TsoAtt to complete
$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
$Web_xxxList of Janus Web Server $functions
$WindexWord number of first occurrence of word in phrase
$X2DConvert hex string to integer