Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- CA-Clipper 5.2 . Technical Reference - <b>workarea</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 WORKAREA
 Information to administrate the workarea
------------------------------------------------------------------------------
 Structure

     typedef struct _WORKAREA_
     {
        struct _DBFUNCTABLE_ far * ftable;
     
        USHORT area;
        FARP   alias;
     
        USHORT fieldExtent;
        USHORT fieldCount;
        FIELDP fields;
     
        ITEM result;
     
        BOOL top;
        BOOL bottom;
        BOOL bof;
        BOOL eof;
        BOOL found;
     
        DBSCOPEINFO  locate;
        DBFILTERINFO filter;
     
        DBRELINFOP relations;
        USHORT     parents;
     
        HANDLE heap;
        USHORT heapSize;
     
        USHORT rddID;
     
     } WORKAREA;
     
     typedef WORKAREA far * WORKAREAP;

 Elements

     ftable

        Contains a pointer to the virtual method table for this workarea (see
        DBFUNCTABLE).

     area

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

     alias

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

     fieldExtent

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

     fieldCount

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

     fields

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

     result

        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.

     top

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

     bottom

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

     bof

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

     eof

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

     found

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

     locate

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

     filter

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

     relations

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

     parents

        Contains a numeric value specifying the number of parent workareas
        currently in effect for this workarea.

     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
     below, the WORKAREA structure is used by all methods in the RDD API.

 Files:  Header file is Rdd.api.

 Used by:   DBRELINFO, DBTRANSINFO


See Also: DBRELINFO DBTRANSINFO

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson