| TITLE | VALUE | |
|---|---|---|
| NAME | ROR GUI PARAMETER GET | |
| DESCRIPTION | The ROR GUI PARAMETER GET remote procedure retrieves the value of the GUI parameter. | |
| TAG | GETPARM | |
| ROUTINE | RORRP038 | |
| INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
| INPUT PARAMETER | INSTANCE | |
| 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). | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | YES | |
| MAXIMUM DATA LENGTH | 91 | |
| INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
| INPUT PARAMETER | ENTITY | |
| 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). | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | ||
| MAXIMUM DATA LENGTH | 30 | |
| RETURN VALUE TYPE | ARRAY | |
| RETURN PARAMETER DESCRIPTION | A negative value of the first "^"-piece of the Results[0] indicates that an error occurred during the execution of the remote procedure. In this 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 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 Results[1] Value of the single-line parameter or the first line of the text value Results[...] Subsequent lines of the text value | |
| AVAILABILITY | RESTRICTED | |
| INACTIVE | ||
| CLIENT MANAGER | ||
| WORD WRAP ON | TRUE | |
| VERSION | 1 | |
| SUPPRESS RDV USER SETUP | ||
| APP PROXY ALLOWED | ||