[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 NETUSE
 Open a database file in a network environment.
------------------------------------------------------------------------------
 Syntax:

     NETUSE [<xcDatabase>
        [INDEX <xcIndex list>]
        [ALIAS <xcAlias>] [EXCLUSIVE | SHARED]
        [NEW] [READONLY]
        [VIA <cDriver>]]

 Arguments:

     <xcDatabase> is the name of the database file to open and may be
     specified either as a literal filename or as a character expression
     enclosed in parentheses.


     INDEX <xcIndex list> specifies the names of 1 to 15 index files to
     open in the current work area.  Specify each index as a literal filename
     or as a character expression enclosed in parentheses.  The first index
     in the list becomes the controlling index.  If you specify an <xcIndex>
     as an expression and the value returned is spaces or NIL, it is ignored.

     ALIAS <xcAlias> specifies the name to associate with the work area
     when the database file is opened.  You may specify the alias name as a
     literal name or as a character expression enclosed in parentheses.  A
     valid <xcAlias> may be any legal identifier (i.e., it must begin with an
     alphabetic character and may contain numeric or alphabetic characters
     and the underscore).  Within a single application, CA-Clipper  will not
     accept duplicate aliases.  If this clause is omitted, the alias defaults
     to the database filename.

     EXCLUSIVE opens the database file for nonshared use in a network
     environment.  All other users are denied access until the database file
     is CLOSEd.

     SHARED opens the database file for shared use in a network
     environment.  Specifying this clause overrides the current EXCLUSIVE
     setting.

     NEW opens <xcDatabase> in the next available work area making it the
     current work area.  If this clause is not specified, <xcDatabase> is
     opened in the current work area.

     READONLY opens <xcDatabase> with a read-only attribute.  This lets
     you open database files marked read-only.  If you cannot open the
     <xcDatabase> this way, a runtime error is generated.  If this clause is
     not specified, <xcDatabase> is opened read-write.

     VIA <cDriver> specifies the replaceable database driver (RDD) with
     which to process the current work area.  <cDriver> is name of the RDD
     specified as a character expression.  If <cDriver> is specified as a
     literal value, it must be enclosed in quotes.

     If the VIA clause is omitted, the DBFNTX driver is used by default.
     Note that if the specified driver is not linked, an unrecoverable error
     occurs.

     In no arguments are specified, the database file open in the current
     work area is closed.

 Description:

     NETUSE opens an existing database (.dbf) file, its associated memo
     (.dbt) file, and optionally associated index (.ntx or .ndx) file(s) in
     the current or the next available work area.  In CA-Clipper, there are
     250 work areas with a maximum of 255 total files open in DOS 3.3 and
     above.  Before NETUSE opens a database file and its associated files, it
     closes any active files already open in the work area.  When a database
     file is first opened, the record pointer is positioned at the first
     logical record in the file (record one if there is no index file
     specified).

     In a network environment, you may open database files as EXCLUSIVE or
     SHARED.  EXCLUSIVE precludes the NETUSE of the database file by other
     users until the file is closed.  SHARED allows other users to USE the
     database file for concurrent access.  If the database file is SHARED,
     responsibility for data integrity falls upon the application program.
     In CA-Clipper, FLOCK() and RLOCK() are the two basic means of denying
     other users access to a particular work area or record.  If a USE is
     specified and neither EXCLUSIVE nor SHARED are specified, the database
     file is opened according to the current EXCLUSIVE setting.  In
     CA-Clipper, all USE commands should explicitly specify how the database
     file is to be opened, EXCLUSIVE or SHARED.  The implicit open mode
     specified by SET EXCLUSIVE is supplied for compatibility purposes only
     and not recommended.

     If an error occurs during the opening process, the user is prompted to
     try again or abort.  If the user aborts a BREAK is issued.  Because a
     BREAK is issued it is possible to perform damage control by surrounding
     the process which uses the file(s) with a BEGIN SEQUENCE and
     END SEQUENCE.

 Notes:

     .  Setting the maximum open files: Control of the number of file
        handles available to a CA-Clipper application is controlled by a
        combination of the CONFIG.SYS FILES command, and the F parameter of
        the CLIPPER environment variable.  The F parameter specifies the
        maximum number of files that can be open at any one time within the
        current CA-Clipper program.  CA-Clipper determines the number of
        files that can be opened using the smaller of the two parameters.
        For example, if the FILES command is set to 120 and the F parameter
        is set to 50, the maximum number of files that can be opened is 50.

        The file limit is controlled by the operating system.  Under DOS
        versions less than 3.3, the maximum number of files that can be
        opened at one time is 20 files.  In DOS versions 3.3 and greater, the
        maximum limit is 255 files.

     .  Opening the same database file in more than one work area:
        Although opening a database file in more than one work area is
        possible in a network environment, this practice is strongly
        discouraged.  If done, each file must be opened with a different
        alias, otherwise a runtime error will occur.

     .  Opening two database files with the same names, in different
        directories: Although opening two database files with the same
        names, in different directories is possible, the database files MUST
        have unique alias names, otherwise a runtime error will occur.

 Examples:

     BEGIN SEQUENCE
        NETUSE employee INDEX employee NEW
        NETUSE client INDEX client NEW
        // do some processing
        .....
        .....
        // finished the processing
     END SEQUENCE
     DBNetClose( { "employee", "client" } )


 Files:  Library is CUACLIP.LIB.

See Also: DBNetUse() DBNetClose()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson