Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Info |  Details
Print Page as PDF
Sub-Field: 8994.02

Package: RPC Broker

REMOTE PROCEDURE(#8994)-->8994.02

Sub-Field: 8994.02


Information

Parent File Name Number Package
REMOTE PROCEDURE(#8994) INPUT PARAMETER 8994.02 RPC Broker

Details

Field # Name Loc Type Details
.01 INPUT PARAMETER 0;1 FREE TEXT

  • INPUT TRANSFORM:  K:$L(X)>30!($L(X)<3) X
  • LAST EDITED:  DEC 13, 1994
  • HELP-PROMPT:  Answer must be 3-30 characters in length.
  • DESCRIPTION:  
    This field is used to identify an input parameter for the API.
  • CROSS-REFERENCE:  8994.02^B
    1)= S ^XWB(8994,DA(1),2,"B",$E(X,1,30),DA)=""
    2)= K ^XWB(8994,DA(1),2,"B",$E(X,1,30),DA)
.02 PARAMETER TYPE 0;2 SET
  • '1' FOR LITERAL;
  • '2' FOR LIST;
  • '3' FOR WORD PROCESSING;
  • '4' FOR REFERENCE;

  • LAST EDITED:  AUG 07, 1997
  • HELP-PROMPT:  Select the appropriate value indicating whether the parameter is a literal, a list, a reference or a word processing string.
  • DESCRIPTION:  This field is used to indicate the type (Literal, List, Reference, or Word Processing entry) of value passed by this parameter. The Literal, List, and Reference types correspond to the TParamType of the same name. A
    Word Processing type would also be a List TParamType.
  • TECHNICAL DESCR:  Currently, this field is used only for documenting the RPC's input parameters.
    In version 1.0 of the RPC Broker the Literal type was called Single Value and the List type was called Array.
.03 MAXIMUM DATA LENGTH 0;3 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>32000)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  DEC 13, 1994
  • HELP-PROMPT:  Indicate the maximum length of the parameter, type a Number between 1 and 32000, 0 Decimal Digits
  • DESCRIPTION:  
    This field indicates the maximum length that would be expected for the parameter value.
.04 REQUIRED 0;4 SET
  • '1' FOR YES;
  • '0' FOR NO;

  • LAST EDITED:  DEC 15, 1994
  • HELP-PROMPT:  This field is used to indicate when an input parameter is required in the API call.
  • DESCRIPTION:  
    This field is used to indicate that the input parameter is a required argument in the API call.
.05 SEQUENCE NUMBER 0;5 NUMBER

  • INPUT TRANSFORM:  K:+X'=X!(X>30)!(X<1)!(X?.E1"."1N.N) X
  • LAST EDITED:  MAR 28, 1997
  • HELP-PROMPT:  Type a Number between 1 and 30, 0 Decimal Digits
  • DESCRIPTION:  This number should correspond to the position of this parameter in the formal list of the function. Consider that the return parameter that Broker passes in, by reference, is the very first parameter with the sequence
    number of 0. The next parameter is the first application-supplied parameter with the sequence of 1.
    Example:
    Your entry point may look like:
    EN(RESULT,USER,DATE) ;this will do something
    In this case the parameter corresponding to USER should have sequence
    number 1 and the DATE parameter should be 2.
  • CROSS-REFERENCE:  8994.02^PARAMSEQ
    1)= S ^XWB(8994,DA(1),2,"PARAMSEQ",$E(X,1,30),DA)=""
    2)= K ^XWB(8994,DA(1),2,"PARAMSEQ",$E(X,1,30),DA)
1 DESCRIPTION 1;0 WORD-PROCESSING #8994.021
Info |  Details