User_Options

Functions

HC_EXTERNAL HIC_API void HIC_PShow_One_Net_User_Data (HIC_Rendition const *nr, int count, HC_KEY const keys[], HC_POINTER_SIZED_INT index, void *data, long data_length, long *data_length_out)
 
HC_EXTERNAL HIC_API bool HIC_PShow_One_Net_User_Option (HIC_Rendition const *nr, int count, HC_KEY const keys[], char const *uoname, char *options)
 
HC_EXTERNAL HIC_API void * HIC_Set_User_Index (HIC_Rendition const *nr, int index, const void *value)
 
HC_EXTERNAL HIC_API void * HIC_Set_User_Option_By_Index (HIC_Rendition const *nr, int index, const char *value)
 
HC_EXTERNAL HIC_API void HIC_Show_One_User_Data_By_Key (HIC_Rendition const *nr, HC_KEY key, HC_POINTER_SIZED_INT index, void *data, long data_length, long *data_length_out)
 
HC_EXTERNAL HIC_API bool HIC_Show_One_User_Option_By_Key (HIC_Rendition const *nr, HC_KEY key, char const *uoname, char *options)
 
HC_EXTERNAL HIC_API void * HIC_Show_User_Index (HIC_Rendition const *nr, int index)
 
HC_EXTERNAL HIC_API void * HIC_Show_User_Option_By_Index (HIC_Rendition const *nr, int index)
 

Detailed Description

Function Documentation

◆ HIC_PShow_One_Net_User_Data()

HC_EXTERNAL HIC_API void HIC_PShow_One_Net_User_Data ( HIC_Rendition const *  nr,
int  count,
HC_KEY const  keys[],
HC_POINTER_SIZED_INT  index,
void *  data,
long  data_length,
long *  data_length_out 
)
Parameters
nrA pointer to a const HIC_Rendition.
countAn int.
keysAn HC_KEY array.
indexThe desired data index.
dataThe output buffer.
data_lengthThe output buffer length.
data_length_outThe length of the data returned.

This function fills in the data for the given path, if it doesn't exists data_length_out will be zero.

◆ HIC_PShow_One_Net_User_Option()

HC_EXTERNAL HIC_API bool HIC_PShow_One_Net_User_Option ( HIC_Rendition const *  nr,
int  count,
HC_KEY const  keys[],
char const *  uoname,
char *  options 
)
Parameters
nrA pointer to a const HIC_Rendition.
countAn int.
keysAn HC_KEY array.
uonameThe desired option string.
optionsThe output buffer.

This function fills in the option for the given path, if it exists and return true.

◆ HIC_Set_User_Index()

HC_EXTERNAL HIC_API void* HIC_Set_User_Index ( HIC_Rendition const *  nr,
int  index,
const void *  value 
)
Parameters
nrA pointer to a const HIC_Rendition.
indexAn int.
valueA pointer to a const char.
Returns
A void pointer.

This function sets the value of the user option corresponding to the given index, if it exists, otherwise it is created and inserted into the user option-by-index list.

◆ HIC_Set_User_Option_By_Index()

HC_EXTERNAL HIC_API void* HIC_Set_User_Option_By_Index ( HIC_Rendition const *  nr,
int  index,
const char *  value 
)
Parameters
nrA pointer to a const HIC_Rendition.
indexAn int.
valueA pointer to a const char.
Returns
A void pointer.

This function sets user option by index.

◆ HIC_Show_One_User_Data_By_Key()

HC_EXTERNAL HIC_API void HIC_Show_One_User_Data_By_Key ( HIC_Rendition const *  nr,
HC_KEY  key,
HC_POINTER_SIZED_INT  index,
void *  data,
long  data_length,
long *  data_length_out 
)
Parameters
nrA pointer to a const HIC_Rendition.
keyAn HC_KEY.
indexThe desired data index.
dataThe output buffer.
data_lengthThe output buffer length.
data_length_outThe length of the data returned.

This function fills in the data for the given path, if it doesn't exists data_length_out will be zero.

◆ HIC_Show_One_User_Option_By_Key()

HC_EXTERNAL HIC_API bool HIC_Show_One_User_Option_By_Key ( HIC_Rendition const *  nr,
HC_KEY  key,
char const *  uoname,
char *  options 
)
Parameters
nrA pointer to a const HIC_Rendition.
keyAn HC_KEY.
uonameThe desired option string.
optionsThe output buffer.

This function fills in the option for the given path, if it exists and return true.

◆ HIC_Show_User_Index()

HC_EXTERNAL HIC_API void* HIC_Show_User_Index ( HIC_Rendition const *  nr,
int  index 
)
Parameters
nrA pointer to a const HIC_Rendition.
indexAn int.

This function returns the option value for the given index, if it exists, otherwise returns null.

◆ HIC_Show_User_Option_By_Index()

HC_EXTERNAL HIC_API void* HIC_Show_User_Option_By_Index ( HIC_Rendition const *  nr,
int  index 
)
Parameters
nrA pointer to a const HIC_Rendition.
indexAn int.
Returns
A void pointer.

This function gets the user option by index.