home *** CD-ROM | disk | FTP | other *** search
/ Frostbyte's 1980s DOS Shareware Collection / floppyshareware.zip / floppyshareware / DOOG / CBASE09.ZIP / BTREE.ZIP / BTCURSOR.C < prev    next >
Text File  |  1989-08-31  |  873b  |  29 lines
  1. /*    Copyright (c) 1989 Citadel    */
  2. /*       All Rights Reserved        */
  3.  
  4. /* #ident    "btcursor.c    1.1 - 89/07/03" */
  5.  
  6. /*man---------------------------------------------------------------------------
  7. NAME
  8.      btcursor - btree cursor
  9.  
  10. SYNOPSIS
  11.      #include <btree.h>
  12.  
  13.      void *btcursor(btp)
  14.      btree_t *btp;
  15.  
  16. DESCRIPTION
  17.      btcursor is used to determine if the cursor for btree btp is currently
  18.      positioned on a key or is null.  If the cursor is set to null, the
  19.      NULL pointer is returned.  If the cursor is positioned to a key, a
  20.      non-NULL value is returned.  If btp does not point to a valid open
  21.      btree, the results are undefined.  btcursor is a macro.
  22.  
  23. SEE ALSO
  24.      btfirst, btlast, btnext, btgetk, btprev.
  25.  
  26. ------------------------------------------------------------------------------*/
  27.  
  28. /* btcursor #defined in btree.h. */
  29.