List of Janus Web Server $functions: Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
Line 6: Line 6:


<table class="wikitable">
<table class="wikitable">
<tr><th>$Function</th><th>Description</th></tr>
<tr class="head"><th>$Function</th><th>Description</th></tr>
<!-- ************************************************************** -->
<!-- ************************************************************** -->
<!-- Note that FUNSCHECK.WIKI depends on the format of the function name/description rows - *** SO DON'T MUCK WITH IT!!! *** -->
<!-- Note that FUNSCHECK.WIKI depends on the format of the function name/description rows - *** SO DON'T MUCK WITH IT!!! *** -->

Latest revision as of 15:44, 3 June 2014

The following are the available Janus Web Server $functions.

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

$FunctionDescription
$Sir_LoginPerform secured web or sockets login
$WebDetermine whether running a web request
$Web_BrowserRetrieve browser version
$Web_Cert_InfoRetrieve client certificate information
$Web_Cert_LevelsDetermine Number of client certificate levels
$Web_CipherDetermine SSL cipher used on connection
$Web_Cookie_Len, $Web_Cookie_Parm_LenLength of cookie
$Web_Cookie_NameName of cookie
$Web_Cookie_ParmValue of cookie
$Web_Date, $Web_DateND, $Web_DateNM, and $Web_DateNSCurrent Date as Number
$Web_Date2D, $Web_Date2N, $Web_Date2ND, $Web_Date2NM, $Web_Date2NSConvert Date to Number
$Web_D2Date, $Web_N2Date, $Web_ND2Date, $Web_NM2Date, $Web_NS2DateConvert Number to Date
$Web_DBCSModify DBCS output translation
$Web_Del_SelDelete a global select element
$Web_DoneSend Web response
$Web_End_SesTerminate a logical login session
$Web_End_SSLSesTerminate an SSL session
$Web_ExpireSet expiration Date/time of Web response
$Web_File_ContentRetrieve input contents
$Web_FlushClear contents of Web response buffer
$Web_Form_ActionReturn action URL
$Web_Form_Action_LenReturn action URL length
$Web_Form_DoneSend Web Response for a Form
$Web_Form_LenLength of Form field
$Web_Form_LineValue of line in Form field
$Web_Form_NameName of Form field
$Web_Form_ParmValue of Form field
$Web_Form_Num_LineNumber of Form field lines
$Web_Form_Parm_LenLength of Form field
$Web_Form_Parm_LineValue of line in Form field
$Web_Form_Parm_LstrValue of Form field to longstring
$Web_Form_Parm_Num_LineNumber of Form field lines
$Web_Get_CookieValue of cookie
$Web_Get_Cookie_LstrValue of cookie to longstring
$Web_Hdr_Len, $Web_Hdr_Parm_LenLength of request header field
$Web_Hdr_NameName of request header field
$Web_Hdr_ParmValue of request header field
$Web_Hdr_Parm_LstrValue of header parameter to longstring
$Web_Input_ContentRetrieve input contents
$Web_IPAddrIP address of browser
$Web_IsIndex_LenLength of IsIndex field
$Web_IsIndex_LineValue of IsIndex field line
$Web_IsIndex_NameName of IsIndex field
$Web_IsIndex_Num_LineNumber of IsIndex field lines
$Web_IsIndex_ParmValue of IsIndex field
$Web_IsIndex_Parm_LenLength of IsIndex field
$Web_IsIndex_Parm_LineValue of IsIndex field line
$Web_IsIndex_Parm_LstrValue of URL parameter to longstring
$Web_IsIndex_Parm_Num_LineNumber of IsIndex field lines
$Web_Last_ModifiedSpecify Date/time response last updated
$Web_LenLength of IsIndex or Form field
$Web_LineValue of IsIndex or Form field line
$Web_List_Receive, $Web_List_RecvReceive uploaded file into $list
$Web_LogMsgGet saved logon message
$Web_NameName of IsIndex or Form field
$Web_NoCacheSet HTTP response headers so fresh page displayed
$Web_NumNumber of IsIndex and Form fields
$Web_Num_CookieNumber of cookies in request
$Web_Num_FormNumber of Form fields with non-null data
$Web_Num_HdrNumber of fields in request header
$Web_Num_IsIndexNumber of IsIndex fields
$Web_Num_LineNumber Form or IsIndex field lines
$Web_Num_LogMsgNumber of saved logon messages
$Web_Num_URL_ParmNumber of URL parameters
$Web_OffSuspend adding terminal output to response
$Web_OnResume adding terminal output to response
$Web_Output_ContentRetrieve current output stream
$Web_Output_TypeRetrieve current output mime-type
$Web_ParmValue of IsIndex or Form field
$Web_Parm_LenLength of IsIndex or Form field
$Web_Parm_LineValue of IsIndex or Form field line
$Web_Parm_LstrValue of URL parameter or Form field to longstring
$Web_Parm_Num_LineNumber Form or IsIndex field
$Web_PasswordPassword sent by browser
$Web_PortName of current WEBSERV port
$Web_Proc_Receive, $Web_Proc_RecvReceive uploaded file into procedure
$Web_Proc_Send, $Web_ProcSendAdd contents of procedure to response
$Web_ProtocolGet security protocol being used for a request
$Web_Put_Bin, $Web_Put_BinaryAdd binary string to response buffer
$Web_Put_TextAdd text string to response buffer
$Web_RealmSet web "realm" for "Unauthorized" response
$Web_RedirectRe-route client to another server
$Web_ResponseSet HTTP response header parameter
$Web_Restore_List, $Web_Rest_ListRestore saved $list
$Web_Restore_Recset, $Web_Rest_RecsetRestore saved Set of records
$Web_Save_ListSave contents of a $list
$Web_Save_RecsetSave Set of records
$Web_Save_SelSave a global select element
$Web_ScreenSet 3270 to HTML mapping options
$Web_SecureCheck if thread running on secure port
$Web_SelBuild select options from global select element, selected is string
$Web_Sel_CheckCheck string against a global select element
$Web_SelpBuild select options from global select element, selected from parameters
$Web_Selp_CheckCheck parameters against a global select element
$Web_SelpsBuild select options from delimited list of strings, selected from parameters
$Web_Selps_CheckCheck parameters against a delimited list of strings
$Web_SelsBuild select options from delimited list of strings, selected is string
$Web_Sels_CheckCheck string against a delimited list of strings
$Web_SelspBuild select options from delimited list of strings, selected from parameters
$Web_Selsp_CheckCheck parameters against a delimited list of strings
$Web_Set_CookieSet a cookie
$Web_Set_Cookie_LstrSet a cookie from a longstring
$Web_SetChange certain web connection Settings
$Web_SubSet delimiter for procedure text substitution
$Web_TypeSet response content type
$Web_URL_Decode and $Web_URL_Decode_LstrDo web URL decoding
$Web_URL_Encode and $Web_URL_Encode_LstrDo web URL encoding
$Web_URL_ParmValue of URL parameter
$Web_URL_Parm_LenLength of URL parameter
$Web_URL_Parm_LineLine of a URL parameter
$Web_URL_Parm_LstrLongstring URL parameter value
$Web_URL_Parm_NameName of URL parameter
$Web_URL_Parm_Num_LineNumber of lines in a URL parameter
$Web_UserUser ID sent by browser