libstoragemgmt_systems.h File Reference
#include "libstoragemgmt_common.h"
Go to the source code of this file.
Function Documentation
const char LSM_DLL_EXPORT* lsm_system_id_get |
( |
lsm_system * |
s |
) |
|
Retrieve the Id for the system. Note: Address returned is valid until lsm_system gets freed, copy return value if you need longer scope. Do not free returned string.
- Parameters:
-
| s | System to retrieve id for. |
- Returns:
- NULL on error, else value.
const char LSM_DLL_EXPORT* lsm_system_name_get |
( |
lsm_system * |
s |
) |
|
Retrieve the Id for the system. Note: Address returned is valid until lsm_system gets freed, copy return value if you need longer scope. Do not free returned string.
- Parameters:
-
| s | System to retrieve id for. |
- Returns:
- NULL on error, else value.
int LSM_DLL_EXPORT lsm_system_record_array_free |
( |
lsm_system * |
s[], |
|
|
uint32_t |
size | |
|
) |
| | |
Frees the resources for an array for lsm_system
- Parameters:
-
| s | Array to release memory for |
| size | Number of elements. |
- Returns:
- LSM_ERR_OK on success, else error reason.
Duplicated a system record. NOTE: Make sure to free resources with a call to lsm_system_record_free
- Parameters:
-
- Returns:
- NULL on memory allocation failure, else duplicated record.
int LSM_DLL_EXPORT lsm_system_record_free |
( |
lsm_system * |
s |
) |
|
Frees the resources for a lsm_system
- Parameters:
-
- Returns:
- LSM_ERR_OK on success, else error reason.
uint32_t LSM_DLL_EXPORT lsm_system_status_get |
( |
lsm_system * |
s |
) |
|
Retrieve the status for the system.
- Parameters:
-
| s | System to retrieve status for |
- Returns:
- System status which is a bit sensitive field, returns UINT32_MAX on bad system pointer.