[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 AREA
 Information to administrate the work area
-------------------------------------------------------------------------------
 Structure

     typedef struct _AREA
     {
        struct _RDDFUNCS far * lprfsHost;
     
        USHORT uiArea;
        FARP   atomAlias;
     
        USHORT  uiFieldExtent;
        USHORT  uiFieldCount;
        LPFIELD lpFields;
        FARP    lpFieldExtents;
     
        ITEM valResult;
     
        BOOL fTop;
        BOOL fBottom;
        BOOL fBof;
        BOOL fEof;
        BOOL fFound;
     
        DBSCOPEINFO  dbsi;
        DBFILTERINFO dbfi;
     
        LPDBORDERCONDINFO lpdbOrdCondInfo;
     
        LPDBRELINFO lpdbRelations;
        USHORT      uiParents;
     
        HANDLE heap;
        USHORT heapSize;
     
        USHORT rddID;
     
     } AREA;
     
     typedef AREA far * LPAREA;

 Elements

     lprfsHost

        Contains a pointer to the virtual method table for this work area (see
        RDDFUNCS).

     uiArea

        Contains a numeric value representing the number assigned to this
        work area.  This number is analogous to the value returned by the
        CA-Clipper SELECT() function.

     atomAlias

        Contains a character data type value representing the CA-Clipper
        ALIAS of the work area.

     uiFieldExtent

        Contains a numeric value specifying the total number of columns
        allocated for the work area.  Columns are allocated by a call to
        setFieldExtent().

     uiFieldCount

        Contains a numeric value specifying the total number of columns
        currently in use by the work area.  uifieldCount is incremented with
        each call to addField().

     lpFields

        Contains a pointer to an array of FIELD items.  lpFields defines all
        the fields used by this work area including type, length, and name
        (see FIELD).

     lpFieldExtents

        Contains a pointer to an array of additional field properties.

     valResult

        Contains an item that is used on occasion by the CA-Clipper runtime
        system and may be used by the RDD developer as an all purpose result
        holder for an operation.

     fTop

        Contains a boolean value that is set to TRUE if the record pointer is
        on the first logical record.

     fBottom

        Contains a boolean value that is set to TRUE if the record pointer is
        on the last logical record.

     fBof

        Contains a boolean value that is set to TRUE if logical beginning of
        file is reached.

     fEof

        Contains a boolean value that is set to TRUE if logical end of file
        is reached.

     fFound

        Contains a boolean value that is set to TRUE when a seek() operation
        successfully locates a key value.

     dbsi

        Contains a data structure specifying the scoping condition used by
        the CA-Clipper LOCATE command (see DBSCOPEINFO).

     dbfi

        Contains a data structure specifying the filter condition to use for
        the work area (see DBFILTERINFO).

     lpdbOrdCondInfo

        Contains a pointer to a data structure specifying the order condition
        to use for the work area (see DBORDERCONDINFO).

     lpdbRelations

        Contains information about relations currently in use by the work area
        (see DBRELINFO).

     uiParents

        Contains a numeric value specifying the number of parent work areas
        currently in effect for this work area.

     heap

        Contains a virtual memory handle that can be used by the RDD
        developer to allocate a VM heap and make use of the VM heap
        suballocation routines available through the Virtual Memory API.

     heapSize

        Contains a numeric value indicating the size of the heap, above.

     rddID

        Reserved.

     Note:  In addition to being used by the data structures indicated
     in the Used By section below, the AREA structure is used by all methods
     in the RDD API.

 Files  Header file is Rdd.api.

 Used By    DBRELINFO, DBTRANSINFO


See Also: DBRELINFO DBTRANSINFO
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson