Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Source Information |  Call Graph |  External References |  All
Print Page as PDF
Remote Procedure: ROR GUI PARAMETER GET

Package: Clinical Case Registries

Remote Procedure: ROR GUI PARAMETER GET


Source Information

Name Value
NAME ROR GUI PARAMETER GET
TAG GETPARM
ROUTINE RORRP038
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
The ROR GUI PARAMETER GET remote procedure retrieves the value of the GUI
parameter.
INPUT PARAMETER
  1. INPUT PARAMETER:   INSTANCE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   91
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The INSTANCE parameter defines the instance name of the GUI parameter. It 
    can also contain the parameter name as the second "^"-piece (by default, 
    the "ROR GUI PARAMETER" is used).
    
  2. INPUT PARAMETER:   ENTITY
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    The ENTITY parameter defines the area(s) where the parameter value is
    searched for. By default ($G(ENTITY)=""), the "ALL" value is used (see the
    DBIA #2263 for more details). The other values that are used most often
    are the "USR" (user settings) and the "PKG" (package settings).
    
RETURN PARAMETER DESCRIPTION
A negative value of the first "^"-piece of the Results[0] indicates that
  Results[i]            Error Descriptor
                          ^01: Error code
                          ^02: Message
                          ^03: Place of the error
Otherwise, the Results[0] contains 0 and the subsequent node(s) of the
Results array contain the string(s) of parameter value:
  Results[0]            0
an error occurred during the execution of the remote procedure. In this
  Results[1]            Value of the single-line parameter or
                        the first line of the text value
  Results[...]          Subsequent lines of the text value
case, the second piece of the Results[0] will contain number of the error
descriptors returned in the subsequent nodes of the Results array:
  Results[0]            Result Descriptor
                          ^01: The last error code
                          ^02: Number of the error descriptors

Call Graph

Call Graph

Call Graph Total: 1

Package Total Call Graph
Clinical Case Registries 1 GETPARM^RORRP038  

External References

Name Field # of Occurrence
GETPARM^RORRP038 1
Source Information |  Call Graph |  External References |  All