Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- C/Database Toolchest Library - name: <b>igetdesc</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
Name:       igetdesc

Purpose:    return description of index

Prototype:  char **igetdesc(Db_Obj *db, Index_Obj *index);

Header:     isam.h

Inputs:     db      - database handle
            index   - index handle

Description:
        igetdesc returns a pointer to the description of the index
        from the database db.  The index description is a list of the
        field names, in order, that make up the key for the index.  The
        returned pointer points to a READ-ONLY array of character strings,
        where each character string is the name of a key field for the index.
        The key field names are in the order that they appear in the compound
        key.  The last element in the array is a NULL pointer.

        You can call showdesc to print an index description to stdout.

        The index description of the Physical Index is just a list of all
        the fields in a record.

Returns:
        Returns pointer to a READ-ONLY array of field names, or NULL for error.

WARNING:
        Do not write over the field names, or dire things will happen.

See Also: showdesc

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