| GENERAL DESCRIPTION |
NAME: GMV PARAMETER
TAG: RPC
ROUTINE: GMVPAR
RETURN VALUE TYPE: GLOBAL ARRAY
AVAILABILITY: SUBSCRIPTION
INACTIVE: ACTIVE
WORD WRAP ON: TRUE
DESCRIPTION:
Sets and retrieves parameter values used by the graphical user interface.
This remote procedure call is documented in Integration Agreement 4367.
INPUT PARAMETER: OPTION
PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 10
REQUIRED: YES
SEQUENCE NUMBER: 1
DESCRIPTION:
Routine tag line to call.
INPUT PARAMETER: ENT
PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 2
DESCRIPTION:
The entity value to use. See Integration Agreement 2263 and FILE 8989.518
for a list of entity values.
INPUT PARAMETER: PAR
PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 3
DESCRIPTION:
The parameter value to use. See FILE 8989.51 for a list of parameter
values. This value must start with the letters "GMV" (no quotes).
INPUT PARAMETER: INST
PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 4
DESCRIPTION:
The instance to use.
INPUT PARAMETER: VAL
PARAMETER TYPE: LITERAL
SEQUENCE NUMBER: 6
DESCRIPTION:
The value assigned to a parameter. Values are stored in FILE 8989.5.
RETURN PARAMETER DESCRIPTION:
This remote procedure call sets and retrieves parameter settings that
are used in the graphical user interface.
The entry point is RPC^GMVPAR.. It has input parameters of RESULTS,
OPTION, ENT, PAR, INST and VAL (ex:
RPC^GMVPAR(RESULTS,OPTION,ENT,PAR,INST,VAL).
The RESULTS variable contains the results of the call or the location
where the results can be found.
The OPTION variable identifies the entry point in the GMVPAR routine
that will be invoked to process the call.
If an error occurrs, the ^TMP global contains:
^TMP($J,0)=-1^error message text
1) When the OPTION value is DELPAR, this RPC deletes the value for the
instance, parameter and entity specified.
The TMP global contains:
^TMP($J,0)=1^Instance deleted
Example:
> S OPTION="DELPAR",ENT="SYS",PAR="GMV DLL VERSION"
> S INST="GMV_VITALSVIEWENTER.DLL:v. 07/21/05 10:34"
> D RPC^GMVPAR(.RESULT,OPTION,ENT,PAR,INST) ZW RESULT
> RESULT="^TMP(538999278)"
> D ^%G
> Global ^TMP($J
> ^TMP(538999278,0)=1^Instance deleted
2) When the OPTION value is ENTVAL, this RPC returns the external value
of the entity specified.
The TMP global contains:
TMP($J,0)=external value
Example:
> S OPTION="ENTVAL",ENT="USR"
> D RPC(.RESULT,OPTION,ENT) ZW RESULT
> RESULT="^TMP(538993252)"
> D ^%G
> Global ^TMP($J
> ^TMP(538993252,0)=TRAXLER,FRANK
3) When the OPTION value is GETLST, this RPC returns a list of instances
and their values for the parameter and entity specified.
The TMP global contains:
^TMP($J,0)=piece1
^TMP($J,n)=piece2^piece3
where piece1 = number of entries returned
piece2 = instance name
piece3 = instance value
n = sequential number starting with 1
Example:
> S OPTION="GETLST",ENT="USR",PAR="GMV USER DEFAULTS"
> D RPC(.RESULT,OPTION,ENT,PAR) ZW RESULT
> RESULT="^TMP(538993252)"
> D ^%G
> Global ^TMP($J
> ^TMP(538993252,0)=44
1)=DefaultTemplate^547;VA(200,|MY DEFAULT|
n)=UNIT_INDEX^0
44)=WARD_INDEX^-1
4) When the OPTION value is GETPAR, this RPC will get the value for the
instance, parameter and entity specified.
The TMP global contains:
^TMP($J,0)=piece1
where piece1 = value
Example:
> S ENT="USR",PAR="GMV USER DEFAULTS",INST="DefaultTemplate"
> S OPTION="GETPAR"
> D RPC(.RESULT,OPTION,ENT,PAR,INST) ZW RESULT
> RESULT="^TMP(538993252)"
> D ^%G
> Global ^TMP($J
> ^TMP(538993252,0)=547;VA(200,|MY DEFAULT|
5) When the OPTION value is SETPAR, this RPC set the value of an
instance for the instance, parameter and entity specified.
The TMP global contains:
^TMP($J,0)=1^Parameter updated
Example:
> S OPTION="SETPAR",ENT="USR",PAR="GMV USER DEFAULTS",INST="SearchDelay"
> S VAL=1.5
> D RPC^GMVPAR(.RESULT,OPTION,ENT,PAR,INST,VAL) ZW RESULT
> RESULT="^TMP(538999278)"
> D ^%G
> Global ^TMP($J
> ^TMP(538999278,0)=1^Parameter updated
|
