libstoragemgmt_disk.h File Reference

#include "libstoragemgmt_common.h"

Include dependency graph for libstoragemgmt_disk.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_disk_record_free (lsm_disk *d)
lsm_disk LSM_DLL_EXPORT *	lsm_disk_record_copy (lsm_disk *d)
int LSM_DLL_EXPORT	lsm_disk_record_array_free (lsm_disk *disk[], uint32_t size)
const char LSM_DLL_EXPORT *	lsm_disk_id_get (lsm_disk *d)
const char LSM_DLL_EXPORT *	lsm_disk_name_get (lsm_disk *d)
lsm_disk_type LSM_DLL_EXPORT	lsm_disk_type_get (lsm_disk *d)
uint64_t LSM_DLL_EXPORT	lsm_disk_number_of_blocks_get (lsm_disk *d)
uint64_t LSM_DLL_EXPORT	lsm_disk_block_size_get (lsm_disk *d)
uint64_t LSM_DLL_EXPORT	lsm_disk_status_get (lsm_disk *d)
const char LSM_DLL_EXPORT *	lsm_disk_system_id_get (lsm_disk *d)

---

Function Documentation

uint64_t LSM_DLL_EXPORT lsm_disk_block_size_get

(

lsm_disk *

d

)

Returns the block size Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

Block size in bytes

const char LSM_DLL_EXPORT* lsm_disk_id_get

(

lsm_disk *

d

)

Returns the disk id Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

String id

Here is the caller graph for this function:

const char LSM_DLL_EXPORT* lsm_disk_name_get

(

lsm_disk *

d

)

Returns the disk name Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

Disk name

uint64_t LSM_DLL_EXPORT lsm_disk_number_of_blocks_get

(

lsm_disk *

d

)

Returns number of blocks for disk Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

Number of logical blocks

int LSM_DLL_EXPORT lsm_disk_record_array_free	(	lsm_disk *	disk[],
		uint32_t	size
	)

Free an array of disk records

Parameters:

	disk	Array of disk records
	size	Size of disk array

Returns:

LSM_ERR_OK on success, else error reason.

Here is the caller graph for this function:

lsm_disk LSM_DLL_EXPORT* lsm_disk_record_copy

(

lsm_disk *

d

)

Copy a disk record

Parameters:

d

Disk record to copy

Returns:

Copy of disk record

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_disk_record_free

(

lsm_disk *

d

)

Free the memory for a disk record

Parameters:

d

Disk memory to free

Returns:

LSM_ERR_OK on success, else error reason.

Here is the caller graph for this function:

uint64_t LSM_DLL_EXPORT lsm_disk_status_get

(

lsm_disk *

d

)

Returns the disk status Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

Status of the disk

const char LSM_DLL_EXPORT* lsm_disk_system_id_get

(

lsm_disk *

d

)

Returns the system id Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

Which system the disk belongs too.

lsm_disk_type LSM_DLL_EXPORT lsm_disk_type_get

(

lsm_disk *

d

)

Returns the disk type (enumeration) Note: Return value is valid as long as disk pointer is valid. It gets freed when record is freed.

Parameters:

d

Disk record of interest

Returns:

Disk type