HC_Show_One_User_Data
-
long
HC_Show_One_User_Data(intptr_t index, void *data, long data_length) - long HC_Show_One_User_Data(intptr_t 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.
HC_Set_User_Data().Parameters
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.
Returns
- 0 if no matching index was found.
- A negative number if the data found was too large for the buffer. The absolute value is the actual size of the user data.
- A positive number if the data found and written into the passed data buffer. The return value indicate the size of the data.