[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 info()
 Retrieve information about the current driver
------------------------------------------------------------------------------
 Prototype

     ERRCODE info(
                    LPAREA wa,
                    USHORT uiInfoType,
                    ITEM itmInfo
                  )

 Arguments

     wa is a pointer to self.

     uiInfoType is a value that determines the type of information to be
     provided.

     itmInfo is a CA-Clipper item which contains the information that
     corresponds to uiInfoType.

 Description

     info() obtains the information about the current work area.

 Default Behavior

     The info() method is used to implement the CA-Clipper DBINFO() function
     and is called any time information about the work area is needed to
     perform an operation.  It returns items of data in response to some
     basic questions concerning the driver's functionality.  Those questions
     are defined by the value passed in uiInfoType.  Some suggested values
     for uiInfoType (constants with "DBI_" prefix) and their associated
     meanings are provided in the header file Rdd.api.

     Warning!  itmInfo must be a valid item.

 Implementation Notes

     .  If your implementation of info() cannot determine the return
        value based on the value of uiInfoType, you should allow the work area
        default implementation to attempt it by calling SUPER_INFO().

     .  DBI_USER is a constant (defined in Rdd.api) that returns the
        minimum value that third-party developers can use for defining new
        uiInfoType parameters.  Values less than DBI_USER are reserved by
        CA-Clipper.

 Files  Header file is Rdd.api.


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