Volume Property Keys

Keys that apply to volumes.

Topics

Constants

kCFURLVolumeNameKey

The name of the volume, returned as a CFString object.

kCFURLVolumeLocalizedNameKey

The user-presentable name of the volume, returned as a CFString object.

kCFURLVolumeLocalizedFormatDescriptionKey

Key for the volume’s descriptive format name, returned as a CFString object.

kCFURLVolumeTotalCapacityKey

Key for the volume’s capacity in bytes, returned as a CFNumber object.

kCFURLVolumeAvailableCapacityKey

Key for the volume’s available capacity in bytes, returned as a CFNumber object.

kCFURLVolumeResourceCountKey

Key for the total number of resources on the volume, returned as a CFNumber object.

kCFURLVolumeSupportsPersistentIDsKey

Key for determining whether the volume supports persistent IDs, returned as a CFBoolean object.

kCFURLVolumeSupportsSymbolicLinksKey

Key for determining whether the volume supports symbolic links, returned as a CFBoolean object.

kCFURLVolumeSupportsHardLinksKey

Key for determining whether the volume supports hard links, returned as a CFBoolean object.

kCFURLVolumeSupportsJournalingKey

Key for determining whether the volume supports journaling, returned as a CFBoolean object.

kCFURLVolumeIsJournalingKey

Key for determining whether the volume is currently journaling, returned as a CFBoolean object.

kCFURLVolumeSupportsSparseFilesKey

Key for determining whether the volume supports sparse files, returned as a CFBoolean object.

kCFURLVolumeSupportsZeroRunsKey

Key for determining whether the volume supports zero runs, returned as a CFBoolean object.

kCFURLVolumeSupportsCaseSensitiveNamesKey

Key for determining whether the volume supports case-sensitive names, returned as a CFBoolean object.

kCFURLVolumeSupportsCasePreservedNamesKey

Key for determining whether the volume supports case-preserved names, returned as a CFBoolean object.

kCFURLVolumeSupportsRootDirectoryDatesKey

Key for determining whether the volume supports reliable storage of times for the root directory, returned as a CFBoolean object.

kCFURLVolumeSupportsVolumeSizesKey

Key for determining whether the volume supports returning volume size information, returned as a CFBoolean object. If true, volume size information is available as values of the kCFURLVolumeTotalCapacityKey and kCFURLVolumeAvailableCapacityKey keys.

kCFURLVolumeSupportsRenamingKey

Key for determining whether the volume can be renamed, returned as a CFBoolean object.

kCFURLVolumeSupportsAdvisoryFileLockingKey

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 CFBoolean object.

kCFURLVolumeSupportsExtendedSecurityKey

Key for determining whether the volume supports extended security (access control lists), returned as a CFBoolean object.

kCFURLVolumeIsBrowsableKey

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 CFBoolean object.

kCFURLVolumeMaximumFileSizeKey

Key for the largest file size supported by the volume in bytes, returned as a CFNumber object, or NULL if it cannot be determined.

kCFURLVolumeIsEjectableKey

Key for determining whether the volume is ejectable from the drive mechanism under software control, returned as a CFBoolean object.

kCFURLVolumeIsRemovableKey

Key for determining whether the volume is removable from the drive mechanism, returned as a CFBoolean object.

kCFURLVolumeIsInternalKey

Key for determining whether the volume is connected to an internal bus, returned as a CFBoolean object, or NULL if it cannot be determined.

kCFURLVolumeIsAutomountedKey

Key for determining whether the volume is automounted, returned as a CFBoolean object.

kCFURLVolumeIsLocalKey

Key for determining whether the volume is stored on a local device, returned as a CFBoolean object.

kCFURLVolumeIsReadOnlyKey

Key for determining whether the volume is read-only, returned as a CFBoolean object.

kCFURLVolumeCreationDateKey

Key for the volume’s creation date, returned as a CFDate object, or NULL if it cannot be determined.

kCFURLVolumeURLForRemountingKey

Key for the URL needed to remount the network volume, returned as a CFURL object, or NULL if a URL is not available.

kCFURLVolumeUUIDStringKey

Key for the volume’s persistent UUID, returned as a CFString object, or NULL if a persistent UUID is not available.

See Also

File System Constants

Common File System Resource Keys

Keys that are applicable to file system URLs.

File Property Keys

Keys that apply to properties of files.

iCloud Constants

These constants can be used to determining whether a file is stored in the cloud and to obtain information about its status.

CFError userInfo Dictionary Keys

Keys in the userInfo dictionary of a CFError object when certain CFURL functions return an error.