xtd::native::drive Class Reference

Definition

Contains drive native API.

Namespace

xtd::native

Library

xtd.core.native

Warning

Internal use only

Protected Static Methods
static bool	get_available_free_space (const std::string &root_path_name, size_t &free_bytes, size_t &total_number_of_bytes, size_t &total_number_of_free_bytes)
	Gets available free space for specified root path.
static int32_t	get_drive_type (const std::string &root_path_name)
	Gets drive type.
static std::vector< std::string >	get_drives ()
	Gets system drive names array.
static bool	get_volume_information (const std::string &root_path_name, std::string &volume_name, std::string &file_system_name)
	Gets volume information.
static bool	set_Volume_label (const std::string &root_path_name, const std::string &volume_name)
	Sets volume label.

Member Function Documentation

get_available_free_space()

static bool xtd::native::drive::get_available_free_space ( const std::string &  root_path_name, size_t &  free_bytes, size_t &  total_number_of_bytes, size_t &  total_number_of_free_bytes  )

staticprotected

Gets available free space for specified root path.

Parameters

root_path_name	root path name to get available free space.
free_bytes	Return number of free bytes in bytes.
total_number_of_bytes	Return total number of bytes in bytes.
total_number_of_free_bytes	Return total number of free bytes in bytes.

Returns

true if succeed; otherwise false.

Warning

Internal use only

get_drive_type()

static int32_t xtd::native::drive::get_drive_type ( const std::string &  root_path_name )

staticprotected

Gets drive type.

Parameters

root_path_name

root path name to get drive type.

Returns

The drive type (see drive_type.h file).

Warning

Internal use only

get_drives()

static std::vector< std::string > xtd::native::drive::get_drives ( )

staticprotected

Gets system drive names array.

Returns

An array of system drive names.

Warning

Internal use only

get_volume_information()

static bool xtd::native::drive::get_volume_information ( const std::string &  root_path_name, std::string &  volume_name, std::string &  file_system_name  )

staticprotected

Gets volume information.

Parameters

root_path_name	The root path name of the volume
volume_name	The name of the volume.
file_system_name	The file system name.

Returns

true if succeed; otherwise false.

Warning

Internal use only

set_Volume_label()

static bool xtd::native::drive::set_Volume_label ( const std::string &  root_path_name, const std::string &  volume_name  )

staticprotected

Sets volume label.

Parameters

root_path_name	The root path name of the volume
volume	The volume name to set.

Returns

true if succeed; otherwise false.

Warning

Internal use only

---

The documentation for this class was generated from the following file:

• xtd.core.native/include/xtd/native/drive.h