attributes() [1/2]

xtd::io::file_attributes xtd::io::file_system_info::attributes

(

)

const

Gets the attributes for the current file or directory.

Returns

xtd::io::file_attributes of the current xtd::io::file_system_info.

Exceptions

xtd::io::file_not_found_exception	The specified file doesn't exist. Only thrown when setting the property value.
xtd::io::directory_not_found_exception	The specified path is invalid. For example, it's on an unmapped drive. Only thrown when setting the property value.
xtd::io::path_too_long_exception	The specified path, file name, or both exceed the system-defined maximum length.
xtd::argument_exception	The specified path, file name, or both exceed the system-defined maximum length.
xtd::io::io_exception	xtd::io::file_system_info::refresh() cannot initialize the data.

Remarks

The value of the xtd::io::file_system_info::attributes property is pre-cached if the current instance of the xtd::io::file_system_info object was returned from any of the following xtd::io::directory_info methods:

• xtd::io::directory_info::get_directories
• xtd::io::directory_info::get_files
• xtd::io::directory_info::get_file_system_infos
• xtd::io::directory_info::enumerate_directories
• xtd::io::directory_info::enumerate_files
• xtd::io::directory_info::enumerate_file_system_infos

The value may be cached when either the value itself or other xtd::io::file_system_info properties are accessed. To get the latest value, call the xtd::io::file_system_info::refresh method.

If the path doesn't exist as of the last cached state, the return value is static_cast<xtd::io::file_attributes>(-1). xtd::io::file_not_found_exception or xtd::io::directory_not_found_exception can only be thrown when setting the value.

The value of this property is a combination of the archive, compressed, directory, hidden, offline, read-only, system, and temporary file attribute flags.

When you set this value, use the bitwise OR operator (|) to apply more than one value. To retain any existing values in the xtd::io::file_system_info::attributes property, include the value of the xtd::io::file_system_info::attributes property in your assignment. For example:

example_file.attributes(example_file.attributes() | file_attributes::read_only; 

Examples

The following example demonstrates the xtd::io::file_system_info::attribute property. This code example is part of a larger example provided for the xtd::io::file_system_info class.

static void display_file_system_info_attributes(const file_system_info& fsi) {
  //  Assume that this entry is a file.
  string entry_type = "File";
 
  // Determine if entry is really a directory
  if ((fsi.attributes() & file_attributes::directory) == file_attributes::directory) {
    entry_type = "Directory";
  }
  //  Show this entry's type, name, and creation date.
  console::write_line("{0} entry {1} was created on {2:D}", entry_type, fsi.full_name(), fsi.creation_time());
}

Examples

file_info2.cpp.