Brief Index      Full Index      Events Index      I.M. Reference

Show_User_Indices

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)
 

Detailed Description

Function Documentation

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().

Parameters
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..

DETAILS

No additional details. See Set_User_Index().

NOTES

The Show_User_Indices() routines return the actual attribute values stored in the particular segment at hand. The Show_Net_User_Indices routines return the effective attribute value for the specified segment. The distinction is that there may or may not be an "actual" stored value for an attribute for a given segment, but there is guaranteed always to be an effective value for every attribute for every segment. Also, "Show Net" will return the cumulative effects of those attributes that concatenate as you go up and down the segment tree (Modelling Matrices and Windows).

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.

Parameters
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..

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

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.

Parameters
count- The number of items in indices. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_User_Index()

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.

Parameters
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.

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().

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.

Parameters
index- The index to be queried.
value- The value pointed to by index. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_User_Index().

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.

Parameters
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.

DETAILS

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 additional details, see Set_User_Index().

Brief Index      Full Index      Events Index      I.M. Reference