c/libcdsb
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

Update page '2.3. vtype_list'

Gregory Lirent 2022-08-17 17:05:09 +03:00
parent 9d3ed0fec2
commit 3de9deee92
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
2.3. vtype_list.md

@ -44,25 +44,37 @@
### [include/extra/list.h](https://gogs.lirent.ru/lirent/libcdsb/src/master/include/extra/list.h) ### [include/extra/list.h](https://gogs.lirent.ru/lirent/libcdsb/src/master/include/extra/list.h)
##### Макросы ##### Макросы
- `int list_get_by_index(vtype_list* x, ssize_t index, void* data, CallbackT callback)` - `int list_get_by_index(vtype_list* x, ssize_t index, void* data, CallbackT callback)`
- Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`. - Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`.
- Принимает значение индекса данных `index`, которые следует вернуть. Отрицательные значения индекса указывают на элементы, начианая с последнего (где индекс -1 указывает на последний элемент массива). Если отрицательное значение индекса по модулю превышает размерность массива, то будет считаться, что запрос сделан с индексом равным нулю. - Принимает значение индекса данных `index`, которые следует вернуть. Отрицательные значения индекса указывают на элементы, начианая с последнего (где индекс -1 указывает на последний элемент массива). Если отрицательное значение индекса по модулю превышает размерность массива, то будет считаться, что запрос сделан с индексом равным нулю.
- Принимает указатель на произвольные пользовательские данные `data`. - Принимает указатель на произвольные пользовательские данные `data`.
- Принимает указатель на функцию-callback (см. начало текущего документа). - Принимает указатель на функцию-callback (см. начало текущего документа).
- Вызывает callback-функцию cо значением находящимся по запрошенному индексу, в качестве аргумента. - Вызывает callback-функцию cо значением находящимся по запрошенному индексу, в качестве аргумента.
- Возвращает -1, если индекс выходит за границы области памяти, принадлежащей контейнеру. В противном случае возвращает значение возвращенное callback-функцией. - Возвращает -1, если индекс выходит за границы области памяти, принадлежащей контейнеру. В противном случае возвращает значение возвращенное callback-функцией.
- `int list_pop_by_index(vtype_list* x, ssize_t index, void* data, CallbackT callback)` - `int list_pop_by_index(vtype_list* x, ssize_t index, void* data, CallbackT callback)`
- Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`. - Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`.
- Принимает значение индекса данных `index`, которые следует вернуть. Отрицательные значения индекса указывают на элементы, начианая с последнего (где индекс -1 указывает на последний элемент массива). Если отрицательное значение индекса по модулю превышает размерность массива, то будет считаться, что запрос сделан с индексом равным нулю. - Принимает значение индекса данных `index`, которые следует вернуть. Отрицательные значения индекса указывают на элементы, начианая с последнего (где индекс -1 указывает на последний элемент массива). Если отрицательное значение индекса по модулю превышает размерность массива, то будет считаться, что запрос сделан с индексом равным нулю.
- Принимает указатель на произвольные пользовательские данные `data`. - Принимает указатель на произвольные пользовательские данные `data`.
- Принимает указатель на функцию-callback (см. начало текущего документа). - Принимает указатель на функцию-callback (см. начало текущего документа).
- Вызывает callback-функцию cо значением находящимся по запрошенному индексу, в качестве аргумента. После чего удаляет данный объект из контейнера. - Вызывает callback-функцию cо значением находящимся по запрошенному индексу, в качестве аргумента. После чего удаляет данный объект из контейнера.
- Возвращает -1, если индекс выходит за границы области памяти, принадлежащей контейнеру. В противном случае возвращает значение возвращенное callback-функцией. - Возвращает -1, если индекс выходит за границы области памяти, принадлежащей контейнеру. В противном случае возвращает значение возвращенное callback-функцией.
- `int list_remove_by_index(vtype_list* x, ssize_t index)` - `int list_remove_by_index(vtype_list* x, ssize_t index)`
- Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`. - Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`.
- Принимает значение индекса данных `index`, которые следует вернуть. Отрицательные значения индекса указывают на элементы, начианая с последнего (где индекс -1 указывает на последний элемент массива). Если отрицательное значение индекса по модулю превышает размерность массива, то будет считаться, что запрос сделан с индексом равным нулю. - Принимает значение индекса данных `index`, которые следует вернуть. Отрицательные значения индекса указывают на элементы, начианая с последнего (где индекс -1 указывает на последний элемент массива). Если отрицательное значение индекса по модулю превышает размерность массива, то будет считаться, что запрос сделан с индексом равным нулю.
- Возвращает `0`, в случае успешного удаления элемента, или `-1` в случае, если индекс выходит за границы области памяти, принадлежащей контейнеру. - Возвращает `0`, в случае успешного удаления элемента, или `-1` в случае, если индекс выходит за границы области памяти, принадлежащей контейнеру.
- `int list_foreach(vtype_list* x, void* data, CallbackT callback)` - `int list_foreach(vtype_list* x, void* data, CallbackT callback)`
- Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`. - Принимает указатель на область памяти, содержащую инициализированное значение **vtype_list** `x`.
- Принимает указатель на произвольные пользовательские данные `data`. - Принимает указатель на произвольные пользовательские данные `data`.
- Принимает указатель на функцию-callback (см. начало текущего документа). - Принимает указатель на функцию-callback (см. начало текущего документа).