Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

$$KSP^XUPARAM(): Return Kernel Site Parameter

Reference Type: Supported, Category: Signon/Security, ICR#: 2541

Description

The $$KSP^XUPARAM extrinsic function retrieves a Kernel site parameter. The following parameters are currently supported:

Format

  $$KSP^XUPARAM(param)

Input Parameters

param:

(required) Site parameter to retrieve. Currently, the following values for param are supported:

  • INST—Internal Entry Number (IEN) of the site’s institution, in the site’s INSTITUTION (#4) file.

  • SPOOL DOC—MAX SPOOL DOCUMENTS PER USER (internal value) from the site’s KERNEL SYSTEM PARAMETERS (#8989.3) file.

  • SPOOL LIFE—MAX SPOOL DOCUMENT LIFE-SPAN (internal value) from the site’s KERNEL SYSTEM PARAMETERS (#8989.3) file.

  • SPOOL LINE—MAX SPOOL LINES PER USER (internal value) from site’s KERNEL SYSTEM PARAMETERS (#8989.3) file.

  • WHERE—Site’s domain name (FREE TEXT value), from the site’s DOMAIN (#4.2) file.

Output

returns:

Returns the requested site parameter value.

Examples

Example 1

>S A6ASITE=$$KSP^XUPARAM("WHERE")

Example 2

>S A6ASPLLF=$$KSP^XUPARAM("SPOOL LIFE")