Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: WEBGRPCS

WEBGRPCS.m

Go to the documentation of this file.
  1. WEBGRPCS ; HON/CKU - WebVRAM RPCs; June 05, 2020 @ 13:38
  1. ;;1.0;WEB VISTA REMOTE ACCESS MANAGEMENT;**3**;June 5, 2020;Build 10
  1. ;
  1. ; This routine contains the WebVRAM RPCs
  1. ;
  1. Q
  1. ;
  1. ;
  1. ; Gets the parameter value as stored in VistA
  1. ;
  1. ; RV: [output] the return value,
  1. ; 0 if none, otherwise "error number^text"
  1. ; ENTITY: [required] refers to the variable pointer used in the
  1. ; the parameter file (#8989.5). may take various forms such as:
  1. ; * internal vptr: ien;GLO(FN,
  1. ; * external vptr: prefix.entryname
  1. ; * 'use current' form: prefix
  1. ; * chained list: use any of above, ^ delimited, or 'ALL'
  1. ; PARAM: [required] refers to the parameter definition (default external
  1. ; form or `internal form)
  1. ; INST: [optional] instance, defaults to 1
  1. ; RVFMT: [optional] return value format, default to "Q" (internal values)
  1. ; "Q" - quick, returns internal value
  1. ; "I" - internal, return internal value
  1. ; "E" - external, returns external value
  1. ; "B" - both, returns internal value^external value
  1. GETPARAM(RV,ENTITY,PARAM,INST,RVFMT) ; short for GET PARAMETER
  1. S INST=$G(INST,1),RVFMT=$G(RVFMT,"Q")
  1. S RV=$$GET^XPAR(ENTITY,PARAM,INST,RVFMT)
  1. Q
  1. ;
  1. ;
  1. ;
  1. ; Adds the parameter value in VistA
  1. ;
  1. ; RV: [output] the return value
  1. ; ENTITY: [required] refers to the variable pointer used in the
  1. ; the parameter file (#8989.5). may take various forms such as:
  1. ; * internal vptr: ien;GLO(FN,
  1. ; * external vptr: prefix.entryname
  1. ; * 'use current' form: prefix
  1. ; * chained list: use any of above, ^ delimited, or 'ALL'
  1. ; PARAM: [required] refers to the parameter definition (default external
  1. ; form or `internal form)
  1. ; VALUE: [required] defaults to external form; or 'internal
  1. ; INST: [optional] instance, defaults to 1
  1. ADDPARAM(RV,ENTITY,PARAM,VALUE,INST) ; short for ADD PARAMETER
  1. S INST=$G(INST,1) N ERROR
  1. D ADD^XPAR(ENTITY,PARAM,INST,VALUE,.ERROR)
  1. S RV=ERROR
  1. Q
  1. ;
  1. ;
  1. ;
  1. ; Update the parameter value in VistA
  1. ;
  1. ; RV: [output] the return value
  1. ; ENTITY: [required] refers to the variable pointer used in the
  1. ; the parameter file (#8989.5). may take various forms such as:
  1. ; * internal vptr: ien;GLO(FN,
  1. ; * external vptr: prefix.entryname
  1. ; * 'use current' form: prefix
  1. ; * chained list: use any of above, ^ delimited, or 'ALL'
  1. ; PARAM: [required] refers to the parameter definition (default external
  1. ; form or `internal form)
  1. ; VALUE: [required] defaults to external form; or 'internal
  1. ; INST: [optional] instance, defaults to 1
  1. UPDPARAM(RV,ENTITY,PARAM,VALUE,INST) ; short for UPDATE PARAMETER
  1. S INST=$G(INST,1) N ERROR
  1. D CHG^XPAR(ENTITY,PARAM,INST,VALUE,.ERROR)
  1. S RV=ERROR
  1. Q
  1. ;
  1. ;
  1. ;
  1. ; Delete the parameter value in VistA
  1. ;
  1. ; RV: the return value, 0 if successful or error^error message
  1. ; ENTITY: [required] refers to the variable pointer used in the
  1. ; the parameter file (#8989.5). may take various forms such as:
  1. ; * internal vptr: ien;GLO(FN,
  1. ; * external vptr: prefix.entryname
  1. ; * 'use current' form: prefix
  1. ; * chained list: use any of above, ^ delimited, or 'ALL'
  1. ; PARAM: [required] refers to the parameter definition (internal or
  1. ; external form)
  1. ; INST: [optional] instance, defaults to 1
  1. DELPARAM(RV,ENTITY,PARAM,INST) ; short for DELETE PARAMETER
  1. S INST=$G(INST,1) N ERROR
  1. D DEL^XPAR(ENTITY,PARAM,INST,.ERROR)
  1. S RV=ERROR
  1. Q