Volume Resource Keys

Resource keys that apply to volumes.

Overview

As a convenience, volume resource property values can be requested from any file system URL. The value returned reflects the property value for the volume on which the resource is located.

Symbols

Constants

static let volumeLocalizedFormatDescriptionKey: URLResourceKey

Key for the volume’s descriptive format name, returned as an NSString object (read-only).

static let volumeTotalCapacityKey: URLResourceKey

Key for the volume’s capacity in bytes, returned as an NSNumber object (read-only).

static let volumeAvailableCapacityKey: URLResourceKey

Key for the volume’s available capacity in bytes, returned as an NSNumber object (read-only).

static let volumeResourceCountKey: URLResourceKey

Key for the total number of resources on the volume, returned as an NSNumber object (read-only).

static let volumeSupportsPersistentIDsKey: URLResourceKey

Key for determining whether the volume supports persistent IDs, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsSymbolicLinksKey: URLResourceKey

Key for determining whether the volume supports symbolic links, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsHardLinksKey: URLResourceKey

Key for determining whether the volume supports hard links, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsJournalingKey: URLResourceKey

Key for determining whether the volume supports journaling, returned as a Boolean NSNumber object (read-only).

static let volumeIsJournalingKey: URLResourceKey

Key for determining whether the volume is currently journaling, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsSparseFilesKey: URLResourceKey

Key for determining whether the volume supports sparse files, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsZeroRunsKey: URLResourceKey

Key for determining whether the volume supports zero runs, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsCaseSensitiveNamesKey: URLResourceKey

Key for determining whether the volume supports case-sensitive names, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsCasePreservedNamesKey: URLResourceKey

Key for determining whether the volume supports case-preserved names, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsRootDirectoryDatesKey: URLResourceKey

Key for determining whether the volume supports reliable storage of times for the root directory, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsVolumeSizesKey: URLResourceKey

Key for determining whether the volume supports returning volume size information, returned as a Boolean NSNumber object (read-only). If true, volume size information is available as values of the volumeTotalCapacityKey andvolumeAvailableCapacityKey keys.

static let volumeSupportsRenamingKey: URLResourceKey

Key for determining whether the volume can be renamed, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsAdvisoryFileLockingKey: URLResourceKey

Key for determining whether the volume implements whole-file advisory locks in the style of flock, along with the O_EXLOCK and O_SHLOCK flags of the open function, returned as a Boolean NSNumber object (read-only).

static let volumeSupportsExtendedSecurityKey: URLResourceKey

Key for determining whether the volume supports extended security (access control lists), returned as a Boolean NSNumber object (read-only) (read-only).

static let volumeIsBrowsableKey: URLResourceKey

Key for determining whether the volume is visible in GUI-based file-browsing environments, such as the Desktop or the Finder application, returned as a Boolean NSNumber object (read-only).

static let volumeMaximumFileSizeKey: URLResourceKey

Key for the largest file size supported by the volume in bytes, returned as a Boolean NSNumber object, or nil if it cannot be determined (read-only).

static let volumeIsEjectableKey: URLResourceKey

Key for determining whether the volume is ejectable from the drive mechanism under software control, returned as a Boolean NSNumber object (read-only).

static let volumeIsRemovableKey: URLResourceKey

Key for determining whether the volume is removable from the drive mechanism, returned as a Boolean NSNumber object (read-only).

static let volumeIsInternalKey: URLResourceKey

Key for determining whether the volume is connected to an internal bus, returned as a Boolean NSNumber object, or nil if it cannot be determined (read-only).

static let volumeIsAutomountedKey: URLResourceKey

Key for determining whether the volume is automounted, returned as a Boolean NSNumber object (read-only).

static let volumeIsLocalKey: URLResourceKey

Key for determining whether the volume is stored on a local device, returned as a Boolean NSNumber object (read-only).

static let volumeIsReadOnlyKey: URLResourceKey

Key for determining whether the volume is read-only, returned as a Boolean NSNumber object (read-only).

static let volumeCreationDateKey: URLResourceKey

Key for the volume’s creation date, returned as an NSDate object, or NULL if it cannot be determined (read-only).

static let volumeURLForRemountingKey: URLResourceKey

Key for the URL needed to remount the network volume, returned as an NSURL object, or nil if a URL is not available (read-only).

static let volumeUUIDStringKey: URLResourceKey

Key for the volume’s persistent UUID, returned as an NSString object, or nil if a persistent UUID is not available (read-only).

static let volumeNameKey: URLResourceKey

The name of the volume, returned as an NSString object (read-write). Settable only if NSURLVolumeSupportsRenamingKey is true.

static let volumeLocalizedNameKey: URLResourceKey

The name of the volume as it should be displayed in the user interface, returned as an NSString object (read-only).

static let volumeIsEncryptedKey: URLResourceKey

Whether the volume is encrypted, returned as NSNumber containing a Boolean value (read-only).

static let volumeIsRootFileSystemKey: URLResourceKey

Whether the volume is the root filesystem, returned as NSNumber containing a Boolean value (read-only).

static let volumeSupportsCompressionKey: URLResourceKey

Whether the volume supports transparent decompression of compressed files using decmpfs, returned as NSNumber containing a Boolean value (read-only).

static let volumeSupportsFileCloningKey: URLResourceKey

Whether the volume supports cloning using clonefile(2), returned as NSNumber containing a Boolean value (read-only).

static let volumeSupportsSwapRenamingKey: URLResourceKey

Whether the volume supports renaming using renamex_np(2) with the RENAME_SWAP option, returned as NSNumber containing a Boolean value (read-only).

static let volumeSupportsExclusiveRenamingKey: URLResourceKey

Whether the volume supports exclusive renaming using renamex_np(2) with the RENAME_EXCL option, returned as NSNumber containing a Boolean value (read-only).