Gets the active index for a cursor.

Syntax

---

edb_getindex(<CursorHandle>)

<CursorHandle> =

Handle of cursor returned by edb_execute function

Returns

---

The active index name if successful, or FALSE
if there are any errors

Usage

---

The edb_getindex function gets the active index for a cursor. This function can only be used with cursors on directly-opened tables. Please see the edb_prepare function for more information on opening tables directly.

You can use the edb_setindex to change the active index order for a table cursor.

Examples

---

<?php

// The following script connects to an ElevateDB
// Server and database, prepares a direct table
// open, sets the active index, and then displays
// the active index using the edb_getindex() function

$con = edb_connect("type=remote;charset=Ansi;address=127.0.0.1;"+
                   "uid=Administrator;pwd=EDBDefault;database=Test");
if (!$con)
  {
  die("Could not connect: " . edb_errmsg());
  }

$cmd = edb_prepare($con,"customer",EDB_COMMAND_TABLE);
$cursor = edb_execute($cmd);

edb_setindex($cursor,"ByCompany");
echo edb_getindex($cursor);

edb_disconnect($con);
?>