libstoragemgmt_accessgroups.h File Reference

#include "libstoragemgmt_types.h"
Include dependency graph for libstoragemgmt_accessgroups.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int LSM_DLL_EXPORT lsm_access_group_record_free (lsm_access_group *group)
int LSM_DLL_EXPORT lsm_access_group_record_array_free (lsm_access_group *ag[], uint32_t size)
lsm_access_group LSM_DLL_EXPORT * lsm_access_group_record_copy (lsm_access_group *ag)
const char LSM_DLL_EXPORT * lsm_access_group_id_get (lsm_access_group *group)
const char LSM_DLL_EXPORT * lsm_access_group_name_get (lsm_access_group *group)
const char LSM_DLL_EXPORT * lsm_access_group_system_id_get (lsm_access_group *group)
lsm_string_list LSM_DLL_EXPORT * lsm_access_group_initiator_id_get (lsm_access_group *group)

Function Documentation

const char LSM_DLL_EXPORT* lsm_access_group_id_get ( lsm_access_group group  ) 

Returns a pointer to the id. Note: Storage is allocated in the access group and will be deleted when the access group gets freed. If you need longer lifespan copy the value.

Parameters:
group Access group to retrieve id for.
Returns:
Null on error (not an access group), else value of group.
lsm_string_list LSM_DLL_EXPORT* lsm_access_group_initiator_id_get ( lsm_access_group group  ) 

Returns a pointer to the initiator list. Note: Storage is allocated in the access group and will be deleted when the access group gets freed. If you need longer lifespan copy the value.

Parameters:
group Access group to retrieve id for.
Returns:
Null on error (not an access group), else value of initiator list.
const char LSM_DLL_EXPORT* lsm_access_group_name_get ( lsm_access_group group  ) 

Returns a pointer to the name. Note: Storage is allocated in the access group and will be deleted when the access group gets freed. If you need longer lifespan copy the value.

Parameters:
group Access group to retrieve id for.
Returns:
Null on error (not an access group), else value of name.
int LSM_DLL_EXPORT lsm_access_group_record_array_free ( lsm_access_group ag[],
uint32_t  size 
)

Frees the resources for an array of access groups.

Parameters:
ag Array of access groups to free resources for
size Number of elements in the array.
Returns:
LSM_ERR_OK on success, else error reason.

Here is the caller graph for this function:

lsm_access_group LSM_DLL_EXPORT* lsm_access_group_record_copy ( lsm_access_group ag  ) 

Copies an access group.

Parameters:
ag Access group to copy
Returns:
NULL on error, else copied access group.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_access_group_record_free ( lsm_access_group group  ) 

Frees the resources for an access group.

Parameters:
group Group to free
Returns:
LSM_ERR_OK on success, else error reason.
const char LSM_DLL_EXPORT* lsm_access_group_system_id_get ( lsm_access_group group  ) 

Returns a pointer to the system id. Note: Storage is allocated in the access group and will be deleted when the access group gets freed. If you need longer lifespan copy the value.

Parameters:
group Access group to retrieve id for.
Returns:
Null on error (not an access group), else value of system id.

Generated on 9 Jul 2015 for libStorageMgmt by  doxygen 1.6.1