HC_Show_Selection_Keys
-
void
HC_Show_Selection_Keys(int *count, Key keys[]) - void HC_Show_Selection_Keys(int count, Key keys)
Returns the key of the item that was selected by the user, and the keys for all the segments in the path to that item.
Show_Selection_Keys returns a combination of the information in Show_Selection_Element() and Show_Selection_Pathname() , in a slightly different format: as a list of keys, rather than as a key plus a list of segment names. The low-level geometry, if any, contributes a key, then the owning segments each contribute their key going up the tree and hopping across whenever an “include” is encountered. The key of the include-reference itself is included in the list. One way to discover the hops is by calling Show_Key_Type() and checking “segment” versus “include”. The last key in the list will always be that of the root (“/”) segment.
Show_Selection_Keys_Count lets you find out in advance how big the keys array is going to have to be.
HC_Get_Selection, HC_Show_Selection, HC_Show_Selection_Element, HC_Show_Selection_Pathname, HC_Show_Selection_Position, HC_Show_Selection_Source, HC_Await_Event, HC_Enable_Selection_Events.Parameters
count: The size of the keys array. Passed by reference always. Returned to user.
keys: The list of keys of the object, the owning segment, the “include” references, all the way back to the root segment, from low to high in the tree. Passed by reference always. Returned to user.