KIM Favorite Realms Documentation

Functions

Function Documentation

kim_error_t kim_favorite_realms_create (  kim_favorite_realms_t *  out_favorite_realms  ) 
 

Create a new a realms list.

Parameters:
out_favorite_realms on exit, a new favorite realms object. Must be freed with kim_favorite_realms_free().
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_favorite_realms_copy (  kim_favorite_realms_t *  out_favorite_realms,
kim_favorite_realms_t  in_favorite_realms
) 
 

Copy a realms list.

Parameters:
out_favorite_realms on exit, a new favorite realms object which is a copy of in_favorite_realms. Must be freed with kim_favorite_realms_free().
in_favorite_realms a favorite realms object.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_favorite_realms_get_number_of_realms (  kim_favorite_realms_t  in_favorite_realms,
kim_count_t *  out_number_of_realms
) 
 

Get the number of realms in a realms list.

Parameters:
in_favorite_realms a favorite realms object.
out_number_of_realms on exit, the number of realms in in_favorite_realms.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_favorite_realms_get_realm_at_index (  kim_favorite_realms_t  in_favorite_realms,
kim_index_t  in_index,
kim_string_t *  out_realm
) 
 

Get the Nth realm in a realms list.

Parameters:
in_favorite_realms a favorite realms object.
in_index a index into the realms list (starting at 0).
out_realm on exit, the realm at in_index in in_favorite_realms. Must be freed with kim_string_free().
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_favorite_realms_add_realm (  kim_favorite_realms_t  io_favorite_realms,
kim_string_t  in_realm
) 
 

Add a realm string to a realms list.

Parameters:
io_favorite_realms a favorite realms object.
in_realm a realm string to add to in_favorite_realms.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_favorite_realms_remove_realm (  kim_favorite_realms_t  io_favorite_realms,
kim_string_t  in_realm
) 
 

Remove a realm string from a realms list.

Parameters:
io_favorite_realms a favorite realms object.
in_realm a realm string to remove from in_favorite_realms.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

kim_error_t kim_favorite_realms_remove_all_realms (  kim_favorite_realms_t  io_favorite_realms  ) 
 

Empty a realms list.

Parameters:
io_favorite_realms a favorite realms object.
Returns:
On success, KIM_NO_ERROR. On failure, an error object representing the failure.

void kim_favorite_realms_free (  kim_favorite_realms_t *  io_favorite_realms  ) 
 

Free memory associated with a realms list.

Parameters:
io_favorite_realms the favorite realms object to be freed. Set to NULL on exit.