Functions | |
long | Show_One_User_Data (POINTER_SIZED_INT index, void *data, long data_length) |
Returns the user data that has been set on the currently open segment and associated with a specific unique index. More... | |
long | PShow_One_Net_User_Data (int count, HC_KEY const *keys, POINTER_SIZED_INT index, void *data, long data_length) |
Similar to Show_One_User_Data() but returns the net effective settings along a discrete segment path. More... | |
long | Show_User_Data_Indices (POINTER_SIZED_INT *data_indices, long data_indices_count) |
Returns the list of user data indices associated with the current segment. More... | |
long | Show_User_Data_Indices_By_Key (Key key, POINTER_SIZED_INT *data_indices, long data_indices_count) |
Similar to Show_User_Data_Indices() but returns information for the segment associated with the passed key. More... | |
long PShow_One_Net_User_Data | ( | int | count, |
HC_KEY const * | keys, | ||
POINTER_SIZED_INT | index, | ||
void * | data, | ||
long | data_length | ||
) |
Similar to Show_One_User_Data() but returns the net effective settings along a discrete segment path.
count | - The size of keys |
keys | - An array of HC_KEY's delineating a path of segments. |
index | - A unique indentifier associated with the user data. |
data | - A pointer to a buffer which can be populated with binary data associated with the index. |
data_length | - The size of the data buffere beings passed. |
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_Data().
long Show_One_User_Data | ( | POINTER_SIZED_INT | index, |
void * | data, | ||
long | data_length | ||
) |
Returns the user data that has been set on the currently open segment and associated with a specific unique index.
index | - A unique indentifier associated with the user data. |
data | - A pointer to a buffer which can be populated with binary data associated with the index. |
data_length | - The size of the data buffer being passed. |
No additional details. Seet Set_User_Data().
The Show_One_User_Data routines return the actual attribute data buffer stored in the particular segment at hand. The Show_Net_User_Data routines return the effective user data value for the specified segment. The distinction is that there may or may not be an "actual" stored value for the user data at a given segment, but there is guaranteed always to be an effective value for every attribute for every segment.
long Show_User_Data_Indices | ( | POINTER_SIZED_INT * | data_indices, |
long | data_indices_count | ||
) |
Returns the list of user data indices associated with the current segment.
data_indices | - A pointer to a buffer which can be populated with a list of indices. |
data_indices_count | - The size of data_indices buffer. |
No additional details. Seet Set_User_Data().
long Show_User_Data_Indices_By_Key | ( | Key | key, |
POINTER_SIZED_INT * | data_indices, | ||
long | data_indices_count | ||
) |
Similar to Show_User_Data_Indices() but returns information for the segment associated with the passed key.
key | - the key in which the user data indices should be show. |
data_indices | - A pointer to a buffer which can be populated with a list of indices. |
data_indices_count | - The size of data_indices buffer. |
No additional details. Seet Set_User_Data().