libstoragemgmt_volumes.h File Reference

#include "libstoragemgmt_common.h"

Include dependency graph for libstoragemgmt_volumes.h:

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

Functions
int LSM_DLL_EXPORT	lsm_volume_record_free (lsm_volume *v)
lsm_volume LSM_DLL_EXPORT *	lsm_volume_record_copy (lsm_volume *vol)
int LSM_DLL_EXPORT	lsm_volume_record_array_free (lsm_volume *init[], uint32_t size)
const char LSM_DLL_EXPORT *	lsm_volume_id_get (lsm_volume *v)
const char LSM_DLL_EXPORT *	lsm_volume_name_get (lsm_volume *v)
const char LSM_DLL_EXPORT *	lsm_volume_vpd83_get (lsm_volume *v)
uint64_t LSM_DLL_EXPORT	lsm_volume_block_size_get (lsm_volume *v)
uint64_t LSM_DLL_EXPORT	lsm_volume_number_of_blocks_get (lsm_volume *v)
uint32_t LSM_DLL_EXPORT	lsm_volume_admin_state_get (lsm_volume *v)
char LSM_DLL_EXPORT *	lsm_volume_system_id_get (lsm_volume *v)
char LSM_DLL_EXPORT *	lsm_volume_pool_id_get (lsm_volume *v)

Function Documentation

uint32_t LSM_DLL_EXPORT lsm_volume_admin_state_get ( lsm_volume * v )

Retrieves the admin state of the volume.

Parameters:

v

Volume ptr.

Returns:: Admin state of volume, see LSM_VOLUME_ADMIN_STATE_ENABLED and LSM_VOLUME_ADMIN_STATE_DISABLED

uint64_t LSM_DLL_EXPORT lsm_volume_block_size_get ( lsm_volume * v )

Retrieves the volume block size.

Parameters:

v

Volume ptr.

Returns:: Volume block size.

const char LSM_DLL_EXPORT* lsm_volume_id_get ( lsm_volume * v )

Retrieves the volume id. Note: returned value only valid when v is valid!

Parameters:

v

Volume ptr.

Returns:: Volume id.

const char LSM_DLL_EXPORT* lsm_volume_name_get ( lsm_volume * v )

Retrieves the volume name (human recognizable) Note: returned value only valid when v is valid!

Parameters:

v

Volume ptr.

Returns:: Volume name

uint64_t LSM_DLL_EXPORT lsm_volume_number_of_blocks_get ( lsm_volume * v )

Retrieves the number of blocks.

Parameters:

v

Volume ptr.

Returns:: Number of blocks.

char LSM_DLL_EXPORT* lsm_volume_pool_id_get ( lsm_volume * v )

Retrieves the pool id that the volume is derived from.

Parameters:

v

Volume ptr.

Returns:: Pool id.

int LSM_DLL_EXPORT lsm_volume_record_array_free	(	lsm_volume *	init[],
		uint32_t	size
	)

Frees the memory for each of the volume records and then the array itself.

Parameters:

	init	Array to free.
	size	Size of array.

Returns:: LSM_ERR_OK on success, else error reason.

Here is the caller graph for this function:

lsm_volume LSM_DLL_EXPORT* lsm_volume_record_copy ( lsm_volume * vol )

Copies a volume record structure.

Parameters:

vol

Volume record to be copied.

Returns:: NULL on error, else record copy.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_volume_record_free ( lsm_volume * v )

Frees the memory fro an individual volume

Parameters:

v

Volume pointer to free.

Returns:: LSM_ERR_OK on success, else error reason.

Here is the caller graph for this function:

char LSM_DLL_EXPORT* lsm_volume_system_id_get ( lsm_volume * v )

Retrieves the system id of the volume.

Parameters:

v

Volume ptr.

Returns:: System id.

const char LSM_DLL_EXPORT* lsm_volume_vpd83_get ( lsm_volume * v )

Retrieves the SCSI page 83 unique ID. Note: returned value only valid when v is valid!

Parameters:

v

Volume ptr.

Returns:: SCSI page 83 unique ID.

libstoragemgmt_volumes.h File Reference

Functions

Function Documentation