DSIV DDR LISTER (3353)    REMOTE PROCEDURE (8994)

Name Value
NAME DSIV DDR LISTER
TAG LIST
ROUTINE DSIVDDR0
RETURN VALUE TYPE GLOBAL ARRAY
AVAILABILITY AGREEMENT
WORD WRAP ON TRUE
DESCRIPTION
 This calls the Fileman lister, LIST^DIC to get a list of records matching
 the input value
INPUT PARAMETER
  • FILE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This is the file number of the file that will be searched
    
  • IDENTIFY
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   10
    DESCRIPTION:   
    This is the IDENTIFIER parameter in LIST^DIC call
    
  • IENS
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is the standard FileMan IENS string when doing a search/lookup on a 
    multiple in a file.
    
  • FIELD
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   250
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    ';' delimited list of fields requested for each record
    
  • FLAGS
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   15
    REQUIRED:   NO
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    This is the FLAGS parameter for the LIST^DIC API
    
  • NUMBER
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   4
    REQUIRED:   NO
    SEQUENCE NUMBER:   5
    DESCRIPTION:   
    Enter the maximum number of matching records you wish to retrieve.
    
  • FROM
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   6
    DESCRIPTION:   
    Enter the string that will be the starting value to use when transversing 
    the indexes looking for a match.
    
  • PARTIAL
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   7
    DESCRIPTION:   
    This is the PARTIAL parameter in the LIST^DIC call.
    
  • INDEX
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   50
    REQUIRED:   NO
    SEQUENCE NUMBER:   8
    DESCRIPTION:   
    Enter the string of index names (separated by '^') which the search will 
    transverse
    
  • SCREEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   250
    REQUIRED:   NO
    SEQUENCE NUMBER:   9
    DESCRIPTION:   
    If you wish to screen entries, then enter that executable M code. This is 
    the same as DIC("S")
    
RETURN PARAMETER DESCRIPTION
 If successful, return array will be in the following order:
  File Number^IEN^Field Number^Text