DSIV XPAR GET PARAM LIST (3635)    REMOTE PROCEDURE (8994)

Name Value
NAME DSIV XPAR GET PARAM LIST
TAG LIST
ROUTINE DSIVXPR
RETURN VALUE TYPE ARRAY
AVAILABILITY AGREEMENT
WORD WRAP ON TRUE
DESCRIPTION
This will return a detailed list of one or more Kernel Parameter
Definitions.  It does not return every Param Definition field.
 
Either the NAME input parameter or the PREFIX input parameter is 
required.  If you pass a NAME then PREFIX is ignored.
INPUT PARAMETER
  • NAME
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This is the name or the IFN for a Parameter Definition.  Pass this value 
    only if you wish to retrieve the data for one specific Parameter 
    Definition.
    
  • PREFIX
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is the namespace or the leading characters for the Parameter 
    Definitions you wished to be returned.  For example, PREFIX="DSIC" will 
    return all DSIC Kernel Parameter Definitions.
    
RETURN PARAMETER DESCRIPTION
Returns List[n] = value  for n=0,1,2,3,...
              p1 = $START    p2 = Param Def ifn    p3 = Param Def name
              p4 = Multivalued Param [Boolean 1/0/null)
 List[j+1] := p1^p2^p3^p4  for Param Def Instance
              p1 = term    p2 = data type code   p3 = data type
              p4 = domain
 List[j+2] := p1^p2^p3^p4  for Param Def Value
              p1 = term    p2 = data type code   p3 = data type
              p4 = domain
 List[j+3] := s1;s2;s3^s1;s2;s3^s1;s2;s3^...  list of entities
              s1 = precedence order number
 
              s2 = entity name      s3 = entity abbreviation
 List[j+k] := text  where k=4,5,6,...  Parameter description
              these lines will not be returned if there is no 
              description for the Parameter Definition
 List[j+k+1] := $END
If problems encounter, the first row returned will be
  List[0] := -1^message
  List[i] := message  for i=1,2,3,4,...
 
Return list is a multi-lined return for each entry found.  For each 
Parameter definition return:
   List[j] := p1^p2^p3^p4  where