Functions | |
long | Show_One_User_Data (POINTER_SIZED_INT index, void *data, long data_length) |
long | PShow_One_Net_User_Data (int count, HC_KEY const *keys, POINTER_SIZED_INT index, void *data, long data_length) |
long | Show_User_Data_Indices (POINTER_SIZED_INT *data_indices, long data_indices_count) |
long | Show_User_Data_Indices_By_Key (Key key, POINTER_SIZED_INT *data_indices, long data_indices_count) |
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. |
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. |
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. |
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. |