DSIC FM DINUM (1582)    REMOTE PROCEDURE (8994)

Name Value
NAME DSIC FM DINUM
TAG DINUM
ROUTINE DSICFM02
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY AGREEMENT
DESCRIPTION
This will do a lookup on the inputted file for the requested value.  This 
is only for files whose .01 field is defined to be a DINUM pointer to a
file.  If the lookup value in not in the inputted file, then this will 
add that pointer to that file.
INPUT PARAMETER
  • FILE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This is the file number of the DSS file which has a .01 DINUM'd field
    
  • IEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is the ien of the pointed to file.  If the .01 field is not a 
    pointer field then this parameter should not be passed when trying to add 
    a new entry to the file.
    
  • VAL
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   80
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    This is the external value of the .01 field.   If the .01 field is a 
    pointer field, then this would be some external lookup value for the 
    pointed to file.   If the .01 field is not a pointer, then this must 
    numeric.
    
  • IENS
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    This field is only valid if you are trying to add a DINUM'd value to a 
    multiple in the FILE.  The syntax of iens is ,S1,S2,S3,   See M 
    programmers for precise syntax to use if you need this.
    
RETURN PARAMETER DESCRIPTION
Return the internal entry number (ien) of the item looked up or added.
On error, return -1^error message