RPG xTools Add-on Library

CGILIB API Listing

The following list is not inclusive but represents the exposed subprocedures that can be called from the CGILIB. For a list of subprocedures exported from the RPGLIB click here.

Items in BLUE were added recently.

Subprocedure Name Include File Description
GetCookie cgi Return data associated with the specified "cookie".
GetEnvVar cgi Return data associated with an environment variable. The "environment is the CGI environment, but is also available in non-CGI job.
SetEnvVar cgi Change the value associated with an environment variable.
PutEnvVar cgi Changes an environment variable using traditional unix syntax.
DltEnvVar cgi Delete an environment variable.
GetSysEnvVar cgi Return data associated with the system-wide environment.
SetSysEnvVar cgi Change the value associated with a system-wide environment variable.
PutSysEnvVar cgi Change the value associated with a system-wide environment variable using traditional Unix syntax.
DltSysEnvVar cgi Delete a system-wide environment variable.
UnEscape cgi Convert a URL-encoded string to standard text.
cgiInit cgi Initialize the CGILIB. Should be the first procedure called in a CGI program.
cgiGetVar cgi Return data associated with a field from an HTML form. Data is returned via the return value of the subprocedure.
cgiGetVarEx cgi Retrieve data associated with a field from an HTML form. Data is returned via a parameter instead of the return value.
cgiSetProp cgi Allows you to change the default setting for sections and tokens used in externally described HTML.
cgiGetVarL, cgiGetVarU, cgiGetVarDec cgi Return data associated with a field from an HTML form in all lower case, all upper case, or as a numeric value.
cgiGetVarCnt cgi Returns the number of occurrences of a specific variable from an HTML form.
cgiStdOut cgi Write text out to the standard-output device. Supports substitution variables and converts \n symbols into X'25'.
cgiGetContentLen cgi Returns the CGI CONTENT_LENGTH value as numeric.
cgiGetMethod cgi Returns the CGI REQUEST_METHOD value.
cgiSetVar cgi Sets the value of an HTML substitution value to the specified value.
cgiLoadHTML cgi Reads a source file member containing HTML into an internal work buffer.
cgiLoadHTMLIFS cgi Reads a file from the IFS containing HTML into an internal work buffer.
cgiWrtSection cgi Writes a section of HTML with the substitution variables set by the cgiSetVar subprocedure to the web browser.
cgiFlushBuffer cgi Sends the buffered HTML text out to the standard output device.

[ Back to Top ]