LAW&Co. B+Tree Manual  	What follows are manual entries documenting the most common	functions used to integrate the B+Tree into your system.  	The manual is not intended to cover the functionality completely, 	but rather allow the programmer to grasp the basic functionality	of the index, and begin building a working interface to the B+Tree 	from your system.  	Sorry, but this manual has always been a pretty rough draft	and probably always will be. CHECK(3)                       c2man utils.c                       CHECK(3)                                10 April 1995 NAME      CHECK - CHECK SYNOPSIS      void CHECK      (           BTREE *btree,           int pause      ); PARAMETERS      BTREE *btree           Not Documented.      int pause           Not Documented. DESCRIPTION      CHECK. RETURNS      NONE. DISCUSSION      Check the contents of the hierarchy.  Print a report concerning the      contents currently in the hierarchy. SEE ALSO        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader        First FlushHierarchy Increment InsertKey        InstallCompare Last OpenBtree OpenBtree        Update create_c_string create_index_string                                    - 2 -            Formatted:  May 1, 1997 Close(3)                       c2man btree.c                       Close(3)                                13 April 1995 NAME      Close - Close SYNOPSIS      int Close(BTREE *btree); PARAMETERS      BTREE *btree           Pointer to tree descriptor. DESCRIPTION      Shutdown a btree. RETURNS      Result of the block file handler closing function. SEE ALSO        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader        First FlushHierarchy Increment InsertKey        InstallCompare Last OpenBtree OpenBtree        Update create_c_string create_index_string                                    - 3 -            Formatted:  May 1, 1997 CurrentKey(3)                  c2man btree.c                  CurrentKey(3)                                13 April 1995 NAME      CurrentKey - CurrentKey SYNOPSIS      struct KeyGroup *CurrentKey(BTREE *btree); PARAMETERS      BTREE *btree           Pointer to tree descriptor. DESCRIPTION      Identify the current key. RETURNS      Returns a pointer to the key group which is designated as the active      key. SEE ALSO        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader        First FlushHierarchy Increment InsertKey        InstallCompare Last OpenBtree OpenBtree        Update create_c_string create_index_string                                    - 4 -            Formatted:  May 1, 1997 DLL_Count(3)                    c2man dll.c                    DLL_Count(3)                                23 March 1995 NAME      DLL_Count - . SYNOPSIS      int DLL_Count(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_Count Access from:        External      Synopsis:      int DLL_Count() Arguments:          none      Description:        Access function to the link list node count.      Return:        Number of nodes in the list.  History: Created 10/16/91      by Larry A. Walker for Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 5 -            Formatted:  May 1, 1997 DLL_Create(3)                   c2man dll.c                   DLL_Create(3)                                23 March 1995 NAME      DLL_Create - . SYNOPSIS      DLL DLL_Create(void); DESCRIPTION      Function Name: DLL_Create Access from:        External      Synopsis:      DLL DLL_Create(void); Arguments:          none      Description:        Create the DLL descriptor and initialize it      Return:        DLL (pointer to the DLL descriptor ) History: Created      by Larry A. Walker for Modified:. SEE ALSO        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader        First FlushHierarchy Increment InsertKey        InstallCompare Last OpenBtree OpenBtree        Update create_c_string create_index_string                                    - 6 -            Formatted:  May 1, 1997 DLL_Current(3)                  c2man dll.c                  DLL_Current(3)                                23 March 1995 NAME      DLL_Current - . SYNOPSIS      void *DLL_Current(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_Current Access from:        External      Synopsis:      void * DLL_Current() Arguments:          none      Description:        Return a pointer to the data content of the      Current node.  Return:        data pointer, NULL for failure History:      Created 10/16/91 by Larry A. Walker for Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 7 -            Formatted:  May 1, 1997 DLL_Delete(3)                   c2man dll.c                   DLL_Delete(3)                                23 March 1995 NAME      DLL_Delete - . SYNOPSIS      int DLL_Delete(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_Delete Access from:        External      Synopsis:      int DLL_Delete() Arguments:          none      Description:        Delete the active node from the link list The      current active node becomes the prior node unless there is no prior      node, then it becomes then next node on the list.      Return:        DLLSUCCESS or DLLFAIL History: Created 10/16/91 by      Larry A. Walker for Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 8 -            Formatted:  May 1, 1997 DLL_First(3)                    c2man dll.c                    DLL_First(3)                                23 March 1995 NAME      DLL_First - . SYNOPSIS      void *DLL_First(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_First Access from:   External Synopsis:      void *      DLL_First() Arguments:          none Description:   Set the active      pointer to the first node.  Return a pointer to the data content of      the first node.  Return:        data pointer, NULL for failure      History: Created 10/16/91 by Larry A. Walker for       Larry A. Walker      & Co.  Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 9 -            Formatted:  May 1, 1997 DLL_Free(3)                     c2man dll.c                     DLL_Free(3)                                23 March 1995 NAME      DLL_Free - . SYNOPSIS      void DLL_Free(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_Free Access from:        External      Synopsis:      void DLL_Free() Arguments:          DLL      Description:        Free the storage at the current node      Return:        none History: Created 10/16/91 by Larry A. Walker for      Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 10 -            Formatted:  May 1, 1997 DLL_Insert(3)                   c2man dll.c                   DLL_Insert(3)                                23 March 1995 NAME      DLL_Insert - . SYNOPSIS      int DLL_Insert      (           DLL activeDLL,           int where,           void *data      ); PARAMETERS      DLL activeDLL           Not Documented.      int where           Not Documented.      void *data           Not Documented. DESCRIPTION      Function Name: DLL_Insert Access from:   External Synopsis:      int      DLL_Insert( int where, void * data ) Arguments:          data pointer      to Link List data area Description:   If the link list was never      previously created create the link list.  Insert into the list at the      next available node the data pointer and adjust prior node and next      node pointers.  Return:        data pointer, NULL for failure History:      Created by Larry A. Walker for  Larry A. Walker & Co.  Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 11 -            Formatted:  May 1, 1997 DLL_Next(3)                     c2man dll.c                     DLL_Next(3)                                23 March 1995 NAME      DLL_Next - . SYNOPSIS      void *DLL_Next(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_Next Access from:   External Synopsis:      void *      DLL_Next(); Arguments:          none Description:   Set the active      pointer to the next node.  Return a pointer to the data content of the      next node.  Return:        data pointer, NULL for failure History:      Created 10/16/91 by Larry A. WalOer for Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 12 -            Formatted:  May 1, 1997 DLL_Prev(3)                     c2man dll.c                     DLL_Prev(3)                                23 March 1995 NAME      DLL_Prev - . SYNOPSIS      void *DLL_Prev(DLL activeDLL); PARAMETERS      DLL activeDLL           Not Documented. DESCRIPTION      Function Name: DLL_Prev Access from:        External      Synopsis:      void * DLL_Prev() Arguments:          none      Description:        Set the active pointer to the previous node.      Return a pointer to the data content of the previous node.      Return:        data pointer, NULL for failure History: Created      10/16/91 by Larry A. Walker for Modified:. SEE ALSO        DLL_Count DLL_Create DLL_Current DLL_Delete        DLL_First DLL_Free DLL_Insert DLL_Next DLL_Prev                                    - 13 -            Formatted:  May 1, 1997 DUMP(3)                        c2man utils.c                        DUMP(3)                                10 April 1995 NAME      DUMP - DUMP SYNOPSIS      void DUMP(BTREE *btree); PARAMETERS      BTREE *btree           Not Documented. RETURNS      NONE. DISCUSSION      Walk every block in the btree file and write all the header and key      information. SEE ALSO        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader        First FlushHierarchy Increment InsertKey        InstallCompare Last OpenBtree OpenBtree        Update create_c_string create_index_string                                    - 14 -            Formatted:  May 1, 1997 DebugIsOpen(3)                 c2man debug.c                 DebugIsOpen(3)                                23 March 1995 NAME      DebugIsOpen - --- Sometimes we just need to know if debug is on SYNOPSIS      int DebugIsOpen(void); DESCRIPTION      --- Sometimes we just need to know if debug is on. SEE ALSO        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader        First FlushHierarchy Increment InsertKey        InstallCompare Last OpenBtree OpenBtree        Update create_c_string create_index_string                                    - 15 -            Formatted:  May 1, 1997 DebugLevel(3)                  c2man debug.c                  DebugLevel(3)                                23 March 1995 NAME      DebugLevel - --- Sometimes we want to know what the debug level is SYNOPSIS      int DebugLevel(void); DESCRIPTION      --- Sometimes we want to know what the debug level is. SEE ALSO        CHECK Close CurrentKey DUMP DebugIsOpen        DebugLevel Decrement DeleteKey DisplayHeader