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 SET

Package: Clinical Case Registries

Remote Procedure: ROR GUI PARAMETER SET


Source Information

Name Value
NAME ROR GUI PARAMETER SET
TAG SETPARM
ROUTINE RORRP038
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY RESTRICTED
VERSION 1
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).
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 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).
    
  3. INPUT PARAMETER:   VALUE
    PARAMETER TYPE:   LIST
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    The VALUE parameter defines the value of the GUI parameter. It should be
      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';
    either a literal (string value) or a list (text value). You can use the 
      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;
    "@" 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):
    
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.
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

Call Graph

Call Graph

Call Graph Total: 1

Package Total Call Graph
Clinical Case Registries 1 SETPARM^RORRP038  

External References

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