- WEBGRPCS ; HON/CKU - WebVRAM RPCs; June 05, 2020 @ 13:38
- ;;1.0;WEB VISTA REMOTE ACCESS MANAGEMENT;**3**;June 5, 2020;Build 10
- ;
- ; This routine contains the WebVRAM RPCs
- ;
- Q
- ;
- ;
- ; Gets the parameter value as stored in VistA
- ;
- ; RV: [output] the return value,
- ; 0 if none, otherwise "error number^text"
- ; ENTITY: [required] refers to the variable pointer used in the
- ; the parameter file (#8989.5). may take various forms such as:
- ; * internal vptr: ien;GLO(FN,
- ; * external vptr: prefix.entryname
- ; * 'use current' form: prefix
- ; * chained list: use any of above, ^ delimited, or 'ALL'
- ; PARAM: [required] refers to the parameter definition (default external
- ; form or `internal form)
- ; INST: [optional] instance, defaults to 1
- ; RVFMT: [optional] return value format, default to "Q" (internal values)
- ; "Q" - quick, returns internal value
- ; "I" - internal, return internal value
- ; "E" - external, returns external value
- ; "B" - both, returns internal value^external value
- GETPARAM(RV,ENTITY,PARAM,INST,RVFMT) ; short for GET PARAMETER
- S INST=$G(INST,1),RVFMT=$G(RVFMT,"Q")
- S RV=$$GET^XPAR(ENTITY,PARAM,INST,RVFMT)
- Q
- ;
- ;
- ;
- ; Adds the parameter value in VistA
- ;
- ; RV: [output] the return value
- ; ENTITY: [required] refers to the variable pointer used in the
- ; the parameter file (#8989.5). may take various forms such as:
- ; * internal vptr: ien;GLO(FN,
- ; * external vptr: prefix.entryname
- ; * 'use current' form: prefix
- ; * chained list: use any of above, ^ delimited, or 'ALL'
- ; PARAM: [required] refers to the parameter definition (default external
- ; form or `internal form)
- ; VALUE: [required] defaults to external form; or 'internal
- ; INST: [optional] instance, defaults to 1
- ADDPARAM(RV,ENTITY,PARAM,VALUE,INST) ; short for ADD PARAMETER
- S INST=$G(INST,1) N ERROR
- D ADD^XPAR(ENTITY,PARAM,INST,VALUE,.ERROR)
- S RV=ERROR
- Q
- ;
- ;
- ;
- ; Update the parameter value in VistA
- ;
- ; RV: [output] the return value
- ; ENTITY: [required] refers to the variable pointer used in the
- ; the parameter file (#8989.5). may take various forms such as:
- ; * internal vptr: ien;GLO(FN,
- ; * external vptr: prefix.entryname
- ; * 'use current' form: prefix
- ; * chained list: use any of above, ^ delimited, or 'ALL'
- ; PARAM: [required] refers to the parameter definition (default external
- ; form or `internal form)
- ; VALUE: [required] defaults to external form; or 'internal
- ; INST: [optional] instance, defaults to 1
- UPDPARAM(RV,ENTITY,PARAM,VALUE,INST) ; short for UPDATE PARAMETER
- S INST=$G(INST,1) N ERROR
- D CHG^XPAR(ENTITY,PARAM,INST,VALUE,.ERROR)
- S RV=ERROR
- Q
- ;
- ;
- ;
- ; Delete the parameter value in VistA
- ;
- ; RV: the return value, 0 if successful or error^error message
- ; ENTITY: [required] refers to the variable pointer used in the
- ; the parameter file (#8989.5). may take various forms such as:
- ; * internal vptr: ien;GLO(FN,
- ; * external vptr: prefix.entryname
- ; * 'use current' form: prefix
- ; * chained list: use any of above, ^ delimited, or 'ALL'
- ; PARAM: [required] refers to the parameter definition (internal or
- ; external form)
- ; INST: [optional] instance, defaults to 1
- DELPARAM(RV,ENTITY,PARAM,INST) ; short for DELETE PARAMETER
- S INST=$G(INST,1) N ERROR
- D DEL^XPAR(ENTITY,PARAM,INST,.ERROR)
- S RV=ERROR
- Q
- --- Routine Detail --- with STRUCTURED ROUTINE LISTING ---[H[J[2J[HWEBGRPCS 3764 printed Feb 19, 2025@00:12:43 Page 2
- WEBGRPCS ; HON/CKU - WebVRAM RPCs; June 05, 2020 @ 13:38
- +1 ;;1.0;WEB VISTA REMOTE ACCESS MANAGEMENT;**3**;June 5, 2020;Build 10
- +2 ;
- +3 ; This routine contains the WebVRAM RPCs
- +4 ;
- +5 QUIT
- +6 ;
- +7 ;
- +8 ; Gets the parameter value as stored in VistA
- +9 ;
- +10 ; RV: [output] the return value,
- +11 ; 0 if none, otherwise "error number^text"
- +12 ; ENTITY: [required] refers to the variable pointer used in the
- +13 ; the parameter file (#8989.5). may take various forms such as:
- +14 ; * internal vptr: ien;GLO(FN,
- +15 ; * external vptr: prefix.entryname
- +16 ; * 'use current' form: prefix
- +17 ; * chained list: use any of above, ^ delimited, or 'ALL'
- +18 ; PARAM: [required] refers to the parameter definition (default external
- +19 ; form or `internal form)
- +20 ; INST: [optional] instance, defaults to 1
- +21 ; RVFMT: [optional] return value format, default to "Q" (internal values)
- +22 ; "Q" - quick, returns internal value
- +23 ; "I" - internal, return internal value
- +24 ; "E" - external, returns external value
- +25 ; "B" - both, returns internal value^external value
- GETPARAM(RV,ENTITY,PARAM,INST,RVFMT) ; short for GET PARAMETER
- +1 SET INST=$GET(INST,1)
- SET RVFMT=$GET(RVFMT,"Q")
- +2 SET RV=$$GET^XPAR(ENTITY,PARAM,INST,RVFMT)
- +3 QUIT
- +4 ;
- +5 ;
- +6 ;
- +7 ; Adds the parameter value in VistA
- +8 ;
- +9 ; RV: [output] the return value
- +10 ; ENTITY: [required] refers to the variable pointer used in the
- +11 ; the parameter file (#8989.5). may take various forms such as:
- +12 ; * internal vptr: ien;GLO(FN,
- +13 ; * external vptr: prefix.entryname
- +14 ; * 'use current' form: prefix
- +15 ; * chained list: use any of above, ^ delimited, or 'ALL'
- +16 ; PARAM: [required] refers to the parameter definition (default external
- +17 ; form or `internal form)
- +18 ; VALUE: [required] defaults to external form; or 'internal
- +19 ; INST: [optional] instance, defaults to 1
- ADDPARAM(RV,ENTITY,PARAM,VALUE,INST) ; short for ADD PARAMETER
- +1 SET INST=$GET(INST,1)
- NEW ERROR
- +2 DO ADD^XPAR(ENTITY,PARAM,INST,VALUE,.ERROR)
- +3 SET RV=ERROR
- +4 QUIT
- +5 ;
- +6 ;
- +7 ;
- +8 ; Update the parameter value in VistA
- +9 ;
- +10 ; RV: [output] the return value
- +11 ; ENTITY: [required] refers to the variable pointer used in the
- +12 ; the parameter file (#8989.5). may take various forms such as:
- +13 ; * internal vptr: ien;GLO(FN,
- +14 ; * external vptr: prefix.entryname
- +15 ; * 'use current' form: prefix
- +16 ; * chained list: use any of above, ^ delimited, or 'ALL'
- +17 ; PARAM: [required] refers to the parameter definition (default external
- +18 ; form or `internal form)
- +19 ; VALUE: [required] defaults to external form; or 'internal
- +20 ; INST: [optional] instance, defaults to 1
- UPDPARAM(RV,ENTITY,PARAM,VALUE,INST) ; short for UPDATE PARAMETER
- +1 SET INST=$GET(INST,1)
- NEW ERROR
- +2 DO CHG^XPAR(ENTITY,PARAM,INST,VALUE,.ERROR)
- +3 SET RV=ERROR
- +4 QUIT
- +5 ;
- +6 ;
- +7 ;
- +8 ; Delete the parameter value in VistA
- +9 ;
- +10 ; RV: the return value, 0 if successful or error^error message
- +11 ; ENTITY: [required] refers to the variable pointer used in the
- +12 ; the parameter file (#8989.5). may take various forms such as:
- +13 ; * internal vptr: ien;GLO(FN,
- +14 ; * external vptr: prefix.entryname
- +15 ; * 'use current' form: prefix
- +16 ; * chained list: use any of above, ^ delimited, or 'ALL'
- +17 ; PARAM: [required] refers to the parameter definition (internal or
- +18 ; external form)
- +19 ; INST: [optional] instance, defaults to 1
- DELPARAM(RV,ENTITY,PARAM,INST) ; short for DELETE PARAMETER
- +1 SET INST=$GET(INST,1)
- NEW ERROR
- +2 DO DEL^XPAR(ENTITY,PARAM,INST,.ERROR)
- +3 SET RV=ERROR
- +4 QUIT