1lsm_battery_list(3)       Libstoragemgmt C API Manual      lsm_battery_list(3)
2
3
4

NAME

6       lsm_battery_list - Gets a list of batteries on this connection.
7

SYNOPSIS

9       int  lsm_battery_list (lsm_connect *conn, const char *search_key, const
10       char  *search_value,  lsm_battery  **bs[],  uint32_t  *count,  lsm_flag
11       flags);
12

ARGUMENTS

14       conn        Valid lsm_connect pointer.
15
16       search_key  Search  key (NULL for all) Valid search keys are: "id", and
17                   "system_id".
18
19       search_value
20                   Search value.
21
22       bs[]        Output pointer of lsm_battery array.  Returned  value  must
23                   be freed by calling lsm_battery_record_array_free.
24
25       count       Output pointer of uint32_t. Number of batteries.
26
27       flags       Reserved for future use, must be LSM_CLIENT_FLAG_RSVD.
28

VERSION

30       1.3.
31

DESCRIPTION

33       Gets  a  list  of  batteries  on  this connection.  When present, super
34       capacitors  will  also  be  included.   Battery  properties  could   be
35       retrieved by these functions:
36           * lsm_battery_id_get
37           * lsm_battery_name_get
38           * lsm_battery_system_id_get
39           * lsm_battery_type_get
40           * lsm_battery_status_get
41

CAPABILITY

43       LSM_CAP_BATTERIES
44

RETURN

46       Error code as enumerated by 'lsm_error_number'.
47           * LSM_ERR_OK
48               On success or searched value not found.
49           * LSM_ERR_INVALID_ARGUMENT
50               When any argument is NULL or invalid flags or invalid search
51               key.
52           * LSM_ERR_NO_SUPPORT
53               Not supported.
54
55
56
57February 2020                  lsm_battery_list            lsm_battery_list(3)
Impressum