libstoragemgmt_common.h File Reference

#include "libstoragemgmt_types.h"

Include dependency graph for libstoragemgmt_common.h:

This graph shows which files directly or indirectly include this file:

Defines
#define	LSM_DLL_IMPORT
#define	LSM_DLL_EXPORT
#define	LSM_DLL_LOCAL
Functions
lsm_string_list LSM_DLL_EXPORT *	lsm_string_list_alloc (uint32_t size)
int LSM_DLL_EXPORT	lsm_string_list_free (lsm_string_list *sl)
lsm_string_list LSM_DLL_EXPORT *	lsm_string_list_copy (lsm_string_list *src)
int LSM_DLL_EXPORT	lsm_string_list_elem_set (lsm_string_list sl, uint32_t index, const char value)
const char LSM_DLL_EXPORT *	lsm_string_list_elem_get (lsm_string_list *sl, uint32_t index)
uint32_t LSM_DLL_EXPORT	lsm_string_list_size (lsm_string_list *sl)
int LSM_DLL_EXPORT	lsm_string_list_append (lsm_string_list sl, const char add)
int LSM_DLL_EXPORT	lsm_string_list_delete (lsm_string_list *sl, uint32_t index)
int LSM_DLL_EXPORT	lsm_initiator_id_verify (const char init_id, lsm_access_group_init_type init_type)
int LSM_DLL_EXPORT	lsm_volume_vpd83_verify (const char *vpd83)

Define Documentation

#define LSM_DLL_EXPORT

Definition at line 40 of file libstoragemgmt_common.h.

#define LSM_DLL_IMPORT

Definition at line 39 of file libstoragemgmt_common.h.

#define LSM_DLL_LOCAL

Definition at line 41 of file libstoragemgmt_common.h.

Function Documentation

int LSM_DLL_EXPORT lsm_initiator_id_verify	(	const char *	init_id,
		lsm_access_group_init_type *	init_type
	)

Checks to see if initiator id is valid

Parameters:

	init_id	Initiator value
	init_type	Type of initiator id, will get modified to determined if type passed in is UNKNOWN

Returns:: LSM_ERR_OK if initiator id is OK, else LSM_INVALID_ARGUMENT

Definition at line 86 of file lsm_mgmt.cpp.

Here is the call graph for this function:

lsm_string_list LSM_DLL_EXPORT* lsm_string_list_alloc ( uint32_t size )

Allocates storage for string line of specified size.

Parameters:

size

Initial number of strings to allocate

Returns:: NULL on error, else valid lsm_string_list record pointer

Definition at line 131 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_string_list_append	(	lsm_string_list *	sl,
		const char *	add
	)

Appends a char * to the string list, will grow container as needed.

Parameters:

	sl	String list to append to
	add	Character string to add

Returns:: LSM_ERR_OK on success, else error reason

Definition at line 59 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

lsm_string_list LSM_DLL_EXPORT* lsm_string_list_copy ( lsm_string_list * src )

Copies a lsm_string_list record.

Parameters:

src

Source to copy

Returns:: NULL on error, else copy of source.

We had an allocation failure setting an element item

Definition at line 172 of file lsm_datatypes.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_string_list_delete	(	lsm_string_list *	sl,
		uint32_t	index
	)

Deletes the string at the specified index. NOTE: The elements after this one are moved down, thus if you wanted to iterate over the list deleting each element one by one you need to do so in reverse order.

Parameters:

	sl	String list to remove item from
	index	Specified index

Returns:: LSM_ERR_OK on success, else error reason

Definition at line 75 of file lsm_datatypes.cpp.

const char LSM_DLL_EXPORT* lsm_string_list_elem_get	(	lsm_string_list *	sl,
		uint32_t	index
	)

Returns the value at the specified elem index

Parameters:

	sl	Valid string list pointer
	index	Index to retrieve

Returns:: Value at that index position.

Definition at line 121 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_string_list_elem_set	(	lsm_string_list *	sl,
		uint32_t	index,
		const char *	value
	)

Set the specified element with the passed value.

Parameters:

	sl	Valid string list pointer
	index	Element position to set value to
	value	Value to use for assignment

Returns:: LSM_ERR_OK on success, else error reason

Definition at line 89 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_string_list_free ( lsm_string_list * sl )

Frees the memory allocated with the lsmStringListFree

Parameters:

sl

Record to free

Returns:: LSM_ERR_OK on success, else error reason.

Definition at line 152 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

uint32_t LSM_DLL_EXPORT lsm_string_list_size ( lsm_string_list * sl )

Returns the size of the list

Parameters:

sl

Valid string list pointer

Returns:: size of list, note you cannot create a zero sized list, so 0 indicates error with structure

Definition at line 164 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_volume_vpd83_verify ( const char * vpd83 )

Checks to see if volume vpd83 is valid

Parameters:

vpd83

VPD string to check

Returns:: LSM_ERR_OK if vpd is OK, else LSM_INVALID_ARGUMENT

Definition at line 123 of file lsm_mgmt.cpp.

libstoragemgmt_common.h File Reference

Defines

Functions

Define Documentation

Function Documentation