DSIC LOCK (2099)    REMOTE PROCEDURE (8994)

Name Value
NAME DSIC LOCK
TAG LOCK
ROUTINE DSICLOCK
RETURN VALUE TYPE SINGLE VALUE
AVAILABILITY AGREEMENT
DESCRIPTION
This will allow a GUI application issue a LOCK or UNLOCK on a global node 
or a record in a file.  If the LOCK is issued, it is the responsibility 
of the application to issue the UNLOCK.
INPUT PARAMETER
  • REF
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   128
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This can be a closed form of a global or it can be a file number.  If it 
      ^DSI(19621,"B")
    is a file number, then IFN is also required.  The file number can be the 
    file number of the entire file or the subfile number of corresponding to 
    the ^DD() value.  If it is a subfile, then the IFN parameter must be set 
    accordingly.
     
    Examples of globals:
      ^DSI(19621,0) - since there is no record number the global name has to
                      be passed
    
  • IFN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   15
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This is the internal entry number (record number) of the record that you 
    wish to lock or unlock in the file specified in the REF parameter.  IFN 
    is required if the REF parameter is a file or subfile number.
     
    IFN is the IEN if you are locking the entire record.  If you are locking 
    a subrecord in a multiple, the IFN must be a proper IENS at the 
    appropriate level as documented in the Fileman DBS manuals.
    
  • FLAG
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   2
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    This flag indicates whether or not the global reference should be locked 
    or unlocked.  The default value is 1 which means to lock the global.  If 
    it has a value of -1 then unlock the global reference.
    
RETURN PARAMETER DESCRIPTION
If the operation was successful, return 1
Else return -1^message