DSICXPR ICR (5322)

Name

Value

NUMBER

5322

IA #

5322

DATE CREATED

2008/12/23

CUSTODIAL PACKAGE

VA CERTIFIED COMPONENTS - DSSI

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

DSICXPR

NAME

DSICXPR

ORIGINAL NUMBER

5317

GENERAL DESCRIPTION

This ICR records API's in the DSICXPR routine.  This
routine is used by DSS applications for modifications to KERNEL System
Parameters. The routine uses standard FILEMAN and KERNEL calls to derive
results. KERNEL XPAR APIs (Supported ICR #2263) are wrapped by this routine.

STATUS

Active

DURATION

Till Otherwise Agreed

DSICXPR

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

ADD

This API is used by the "DSIC XPAR ADD" rpc. This API
can be used to add a new instance of a parameter.  For this API, the instance
value (p3) is NOT optional.

VARIABLES

TYPE

VARIABLES DESCRIPTION

RET

Output

A subscripted array with a value of 1 or 0 to
indicate success (1 = Success). Some return values will indicate -1^Error
Message.

DATA

Input

Required - p1~p2~p3~p4~p5~p6
p1 - opt     - Entity
p2 - req     - Parameter
p3 - opt/req - Instance
p4 - opt/req - Value
1. required for most calls
2. optional for get type calls
3. not used in delete call
p5 - opt/req - New Instance Value -
p6 - opt     - GET1 format
1. Only used in GET1 call
2. Default to Q
3. For GET and GETALL - ignore,
always default to B

FUN

Input

(Optional)  Default is zero (0). I $G(FUN) then
extrinsic function, else RPC.

ADDWP

This API will allow the addition of a new instance of
a word- processing parameter.  It used by the "DSIC XPAR ADD WP" RPC.

VARIABLES

TYPE

VARIABLES DESCRIPTION

RET

Output

if successful, return 1 if unsuccessful return
-1^error message Some XPAR calls return 0 if the there were no problems but
the lookup failed.

DATA

Input

(Required)
DATA - required - p1~p2~p3~p4~p5~p6
p1 - opt     - Entity
p2 - req     - Parameter
p3 - opt/req - Instance
Optional for all single value
parameters - default to 1
p4 - req - Value

DSICLT

Input

An array of text lines to be added to the
word-processing field.  Array is in format:

ARRAY(1)=line text 1
ARRAY(2)=line text 2
ARRAY(n)=line text n

CHG

This API will allow the modification of a new
instance of a word-processing parameter.  It used by the "DSIC XPAR EDIT" RPC.

VARIABLES

TYPE

VARIABLES DESCRIPTION

RET

Output

If successful, return 1 if unsuccessful return
-1^error message Some XPAR calls return 0 if there were no problems but the
lookup failed.

DATA

Input

required - p1~p2~p3~p4~p5~p6
p1 - opt     - Entity
p2 - req     - Parameter
p3 - opt/req - Instance
Optional for all single value
parameters - default to 1
p4 - req - Value
p5 - req - New Instance Value -

FUN

Input

(Optional)  Default is zero (0). I $G(FUN) then
extrinsic function, else RPC.

DEL

This API will allow the deletion of an instance of a
system parameter.  It used by the "DSIC XPAR DEL" RPC.

VARIABLES

TYPE

VARIABLES DESCRIPTION

RET

Output

if successful,  return 1 if unsuccessful return
-1^error message

Some XPAR calls return 0 if the there were no problems, but the lookup failed.

DATA

Input

(Required) Required - p1~p2~p3~p4
p1 - opt     - Entity
p2 - req     - Parameter
p3 - req - Instance
p4 - opt/req - Value
Optional, but if passed,
it must be equal to "@".

FUN

Input

(Optional)  Default is zero (0). I $G(FUN) then
extrinsic function, else RPC.

SUBSCRIBING PACKAGE

SUBSCRIBING DETAILS

INSURANCE CAPTURE BUFFER

ABOVE PAR

Added 10/3/24 effective with patch DSIY*1.5*6 to
support finding all instances of a specified entity/parameter.

ADVANCED PROSTHETICS ACQUISITION TOOL

Added 10/3/24 effective with patch DSSO*2.0*8 to
support finding all instances of a specified entity/parameter.

DATE ACTIVATED

2009/06/11