| TITLE | VALUE | |
|---|---|---|
| NAME | ROR GUI PARAMETER SET | |
| DESCRIPTION | The ROR GUI PARAMETER SET remote procedure stores the parameter value and associates it with the provided entity (see the DBIA #2263 for more details). | |
| TAG | SETPARM | |
| 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 context that the parameter value is associated with. By default ($G(ENTITY)=""), the "USR" (user settings) value is used (see the DBIA #2263 for more details). The other value that is used most often is the "PKG" (package settings). | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | ||
| MAXIMUM DATA LENGTH | 30 | |
| INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
| INPUT PARAMETER | VALUE | |
| DESCRIPTION | The VALUE parameter defines the value of the GUI parameter. It should be either a literal (string value) or a list (text value). You can use the "@" value to delete the parameter. NOTE: The list (the Mult property) should not contain the 0 subscript (it will not be stored). Example #1 (string value): RPCBroker.Param[0].Value := 'MAIN FORM POS'; RPCBroker.Param[0].PType := literal; RPCBroker.Param[1].Value := ''; RPCBroker.Param[1].PType := literal; RPCBroker.Param[2].Value := '5,5,400,250'; RPCBroker.Param[2].PType := literal; Example #2 (text value): RPCBroker.Param[0].Value := 'COM PORT SETTINGS'; RPCBroker.Param[0].PType := literal; RPCBroker.Param[1].Value := 'PKG'; RPCBroker.Param[1].PType := literal; RPCBroker.Param[2].Mult[1] := 'Port=COM1'; RPCBroker.Param[2].Mult[2] := 'Baud=19200'; RPCBroker.Param[2].PType := list; | |
| PARAMETER TYPE | LIST | |
| REQUIRED | ||
| MAXIMUM DATA LENGTH | ||
| RETURN VALUE TYPE | SINGLE VALUE | |
| 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. | |
| AVAILABILITY | RESTRICTED | |
| INACTIVE | ||
| CLIENT MANAGER | ||
| WORD WRAP ON | ||
| VERSION | 1 | |
| SUPPRESS RDV USER SETUP | ||
| APP PROXY ALLOWED | ||