User_Options

Functions

int	`HIC_PShow_One_Net_User_Option`
int	`HIC_Show_One_User_Option_By_Key`
void	`HIC_PShow_One_Net_User_Data`
void	`HIC_Show_One_User_Data_By_Key`
void *	`HIC_Show_User_Index`
void *	`HIC_Set_User_Index`
void *	`HIC_Show_User_Option_By_Index`
void *	`HIC_Set_User_Option_By_Index`

Detailed Description

group User_Options

Function Documentation

int HIC_PShow_One_Net_User_Option(HIC_Rendition const *nr, int count, HC_KEY const keys[], char const *uoname, char *options)

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

Parameters:

nr – A pointer to a const HIC_Rendition.
count – An int.
keys – An HC_KEY array.
uoname – The desired option string.
options – The output buffer.

int HIC_Show_One_User_Option_By_Key(HIC_Rendition const *nr, HC_KEY key, char const *uoname, char *options)

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

Parameters:

nr – A pointer to a const HIC_Rendition.
key – An HC_KEY.
uoname – The desired option string.
options – The output buffer.

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)

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

Parameters:

nr – A pointer to a const HIC_Rendition.
count – An int.
keys – An HC_KEY array.
index – The desired data index.
data – The output buffer.
data_length – The output buffer length.
data_length_out – The length of the data returned.

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)

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

Parameters:

nr – A pointer to a const HIC_Rendition.
key – An HC_KEY.
index – The desired data index.
data – The output buffer.
data_length – The output buffer length.
data_length_out – The length of the data returned.

void *HIC_Show_User_Index(HIC_Rendition const *nr, int index)

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

Parameters:

nr – A pointer to a const HIC_Rendition.
index – An int.

void *HIC_Set_User_Index(HIC_Rendition const *nr, int index, const void *value)

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.

Parameters:

nr – A pointer to a const HIC_Rendition.
index – An int.
value – A pointer to a const char.

Returns:

A void pointer.

void *HIC_Show_User_Option_By_Index(HIC_Rendition const *nr, int index)

This function gets the user option by index.

Parameters:

nr – A pointer to a const HIC_Rendition.
index – An int.

Returns:

A void pointer.

void *HIC_Set_User_Option_By_Index(HIC_Rendition const *nr, int index, const char *value)

This function sets user option by index.

Parameters:

nr – A pointer to a const HIC_Rendition.
index – An int.
value – A pointer to a const char.

Returns:

A void pointer.