lsm_string_list_delete man page

lsm_string_list_delete — Deletes specified element from lsm_string_list.

Synopsis

int lsm_string_list_delete (lsm_string_list *sl, uint32_t index);

Arguments

sl

lsm_string_list. Pointer of lsm_string_list to update.

index

uint32_t. The element index. Start from 0.

Version

1.0

Description

Deletes the specified element from lsm_string_list. The string of that element will be freed. The pointer retrieved by lsm_string_list_elem_get will be invalid. The element after this one will moved down, thus if you wanted to iterate over the list deleting each element one by one you need to do in reverse order.

Return

Error code as enumerated by 'lsm_error_number':
   * LSM_ERR_OK
       On success.
   * LSM_ERR_INVALID_ARGUMENT
       When any argument is NULL or not a valid lsm_string_list
       pointer.

Info

lsm_string_list_delete October 2017 Libstoragemgmt C API Manual