Brief Index      Full Index      Events Index      I.M. Reference

Show_Renumbered_Key

Functions

HC_KEY Show_Renumbered_Key (HC_KEY key, char *status)
 

Detailed Description

Function Documentation

HC_KEY Show_Renumbered_Key ( HC_KEY  key,
char *  status 
)

Returns the key value of an object after it was renumbered.

Parameters
key- The key generated by HOOPS and returned in a previous call to one of the "Insert" routines, Find_Contents(), or Show_Selection_Element().
status- A string indicating the state of the renumbered key. Returned to user. Passed by reference always.
Returns
the key of the object after it was renumbered.

DETAILS

Use Show_Renumbered_Key to find the key value of an object after it was renumbered. The status parameter gives the state of the key. The possible values are are:

  • invalid : this key is not associated with any object in the database.
  • original : the key was not renumbered.
  • local : the key was renumbered locally.
  • global : the key was renumbered globally.
See Also
Delete_By_Key, Flush_By_Key, Show_Original_Key, Show_Selection_Original_Key, Move_By_Key, Set_User_Options, Show_Key_Status, Show_Key_Type, Show_Selection_Element.

Brief Index      Full Index      Events Index      I.M. Reference