Functions | |
void | Show_User_Indices (int *count, long *indices, void *values) |
void | PShow_Net_User_Indices (int key_count, const HC_KEY *path_keys, int *count, long *indices, void *values) |
void | Show_User_Index_Count (int *count) |
void | PShow_Net_User_Index_Count (int key_count, const HC_KEY *keys, int *count) |
HC_BOOLEAN | Show_One_User_Index (long index, void *value) |
HC_BOOLEAN | PShow_One_Net_User_Index (int count, const HC_KEY *keys, long index, void *value) |
void Show_User_Indices | ( | int * | count, | |
long * | indices, | |||
void * | values | |||
) |
Returns the user indices and values that have been set on the currently open segment by a previous call or calls to Set_User_Index().
count | - The number of items in indices. Passed by reference. Returned to user. | |
indices | - The array of indices corresponding to values. Passed by reference. Returned to user.. | |
values | - The values pointed to by the indices in index. Passed by reference. Returned to user.. |
When the value being passed back is a string, be sure you've declared your string variable to be long enough.
In C, "passed by reference" means that you have to allocate an appropriate variable, either statically or off the stack, and pass a pointer to that variable to the HOOPS routine. To generate a pointer to a variable C, you prefix the variable with a "&". In other languages you normally don't have to do anything different from usual.
The Show_User_Indices() routines will complain if they're called and the attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.
void PShow_Net_User_Indices | ( | int | key_count, | |
const HC_KEY * | path_keys, | |||
int * | count, | |||
long * | indices, | |||
void * | values | |||
) |
Similar to Show_User_Indices(), but returns the net effective settings along a discrete segment path.
key_count | - The size of pathkeys | |
path_keys | - An array of HC_KEY's delineating a path of segments. | |
count | - The number of items in indices. Passed by reference. Returned to user. | |
indices | - The array of indices corresponding to values. Passed by reference. Returned to user.. | |
values | - The values pointed to by the indices in index. Passed by reference. Returned to user.. |
By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.
For other details, see Show_User_Indices().
void Show_User_Index_Count | ( | int * | count | ) |
Returns the size of the indices array.
count | - The number of items in indices. Passed by reference. Returned to user. |
void PShow_Net_User_Index_Count | ( | int | key_count, | |
const HC_KEY * | keys, | |||
int * | count | |||
) |
Similar to Show_User_Index_Count(), but returns the net effective size rather than the local one.
key_count | - The size of pathkeys | |
keys | - An array of HC_KEY's delineating a path of segments. | |
count | - The number of items in indices. Passed by reference. Returned to user. |
By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.
For other details, see Show_User_Index_Count().
HC_BOOLEAN Show_One_User_Index | ( | long | index, | |
void * | value | |||
) |
Similar to Show_User_Index() but returns a single setting, rather than the entire set.
index | - The index to be queried. | |
value | - The value pointed to by index. Passed by reference. Returned to user. |
HC_BOOLEAN PShow_One_Net_User_Index | ( | int | count, | |
const HC_KEY * | keys, | |||
long | index, | |||
void * | value | |||
) |
Similar to Show_One_Net_User_Index() but returns the net settings along a discrete path.
count | - The size of keys | |
keys | - An array of HC_KEY's delineating a path of segments. | |
index | - The index to be queried. | |
value | - The value pointed to by index. Passed by reference. Returned to user. |