Brief Index      Full Index      I.M. Reference

Show_String_Cursor


Functions

void Show_String_Cursor (HC_KEY key, HC_KEY *text_key, int *row, int *col)

Function Documentation

void Show_String_Cursor ( HC_KEY  key,
HC_KEY *  text_key,
int *  row,
int *  col 
)

Retrieves the key of the owning text, and position within that text, of a previously defined string cursor.

Parameters:
key - Unique numeric identifier pointing to a string cursor in the database.
text_key - Identifier pointing to the text which contains the string cursor. Returned to user. Passed by reference always.
row - The row position of the cursor. Returned to user. Passed by reference always.
col - The column position of the cursor. Returned to user. Passed by reference always.

DETAILS

This routine returns the text and position of the string cursor that corresponds to key. This could be used, for example, to save information so that the cursor could be deleted and later restored.

The key for the cursor might come from Find_Contents() or Show_Selection_Element() , or it might have been saved by your program when the cursor was created (via KInsert_String_Cursor() ).

NOTES

RESTRICTIONS

See also:
KInsert_String_Cursor.

Main Index
Brief Index      Full Index      I.M. Functions