DSIV LOCK (3328)    REMOTE PROCEDURE (8994)

Name Value
NAME DSIV LOCK
TAG LOCK
ROUTINE DSIVLOCK
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY AGREEMENT
WORD WRAP ON TRUE
DESCRIPTION
Lock or unlock a global reference from a GUI client
INPUT PARAMETER
  • REF
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    FM file number or $NAME(global) to be locked
    
  • IFN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Required if REF is a file (or subfile) number
    If REF is the top level file number, then IFN is the
      IEN of the record
    If REF is a subdictionary number for a multiple, then
      IFN must be the appropriate IENS for that multiple
      level
    
  • FLAG
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   2
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Flag for locking or unlocking
      1: Lock
     -1: Unlock
     
    Defaults to 1
    
  • FUN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   1
    REQUIRED:   NO
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    Flag to indicate if the call is extrinsic or RPC
     
      1: Extrinsic
      0: RPC
    
RETURN PARAMETER DESCRIPTION
Returns a boolean value.
 
If successful, the return will be 1.
 
If an error occurs, the return will be List[n] = -1^message.