<!--
{
  "availability" : [
    "iOS: 8.0.0 -",
    "iPadOS: 8.0.0 -",
    "macCatalyst: 8.0.0 -",
    "macOS: 10.10.0 -",
    "tvOS: 9.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Foundation",
  "identifier" : "/documentation/Foundation/URLResourceValues",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Foundation"
    ],
    "preciseIdentifier" : "s:10Foundation17URLResourceValuesV"
  },
  "title" : "URLResourceValues"
}
-->

# URLResourceValues

The properties that the file system resources support.

```
struct URLResourceValues
```

## Overview

Not all property values exist for all file system URLs. For example, if a file is located on a volume that doesn’t support creation dates, you can request the creation date property, but the request returns `nil` and doesn’t generate an error.

Only the fields requested by the keys you pass into the `URL` function to receive this value will be populated. The other fields return `nil` regardless of the underlying property on the file system.

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

## Topics

### Application values

[`applicationIsScriptable`](/documentation/Foundation/URLResourceValues/applicationIsScriptable)

A Boolean value that indicates whether the application is scriptable.

[`isApplication`](/documentation/Foundation/URLResourceValues/isApplication)

A Boolean value that indicates whether the resource is an application.

### Directory values

[`isDirectory`](/documentation/Foundation/URLResourceValues/isDirectory)

A Boolean value that indicates whether the resource is a directory.

[`directoryEntryCount`](/documentation/Foundation/URLResourceValues/directoryEntryCount)

The count of file system objects in the directory.

### File values

[`documentIdentifier`](/documentation/Foundation/URLResourceValues/documentIdentifier)

A value that the kernel assigns to identify a document.

[`fileContentIdentifier`](/documentation/Foundation/URLResourceValues/fileContentIdentifier)

A value APFS assigns that identifies a file’s content data stream.

[`fileAllocatedSize`](/documentation/Foundation/URLResourceValues/fileAllocatedSize)

The total allocated size on-disk for the file, in bytes.

[`fileProtection`](/documentation/Foundation/URLResourceValues/fileProtection)

The protection level for the file.

[`fileResourceIdentifier`](/documentation/Foundation/URLResourceValues/fileResourceIdentifier)

An identifier for comparing two file system objects for equality.

[`fileResourceType`](/documentation/Foundation/URLResourceValues/fileResourceType)

The type of the file system object.

[`fileSecurity`](/documentation/Foundation/URLResourceValues/fileSecurity)

The file system object’s security information.

[`fileSize`](/documentation/Foundation/URLResourceValues/fileSize)

The total file size, in bytes.

[`isPurgeable`](/documentation/Foundation/URLResourceValues/isPurgeable)

A Boolean value that indicates whether the file system can delete a file when the system needs to free space.

[`isSparse`](/documentation/Foundation/URLResourceValues/isSparse)

A Boolean value that indicates whether the file has sparse regions.

[`mayHaveExtendedAttributes`](/documentation/Foundation/URLResourceValues/mayHaveExtendedAttributes)

A Boolean value that indicates the file may have extended attributes.

[`isExecutable`](/documentation/Foundation/URLResourceValues/isExecutable)

A Boolean value that indicates whether you can execute the file resource or search a directory resource.

[`isRegularFile`](/documentation/Foundation/URLResourceValues/isRegularFile)

A Boolean value that indicates whether the resource is a regular file.

[`mayShareFileContent`](/documentation/Foundation/URLResourceValues/mayShareFileContent)

A Boolean value that indicates whether the cloned files and their original files may share data blocks.

[`totalFileAllocatedSize`](/documentation/Foundation/URLResourceValues/totalFileAllocatedSize)

The total allocated size of the file, in bytes.

[`totalFileSize`](/documentation/Foundation/URLResourceValues/totalFileSize)

The total displayable size of the file, in bytes.

[`fileIdentifier`](/documentation/Foundation/URLResourceValues/fileIdentifier)

The file system’s internal inode identifier for the item.

### Volume capacity values

[`volumeAvailableCapacity`](/documentation/Foundation/URLResourceValues/volumeAvailableCapacity)

The volume’s available capacity, in bytes.

[`volumeAvailableCapacityForImportantUsage`](/documentation/Foundation/URLResourceValues/volumeAvailableCapacityForImportantUsage)

The volume’s available capacity for storing important resources, in bytes.

[`volumeAvailableCapacityForOpportunisticUsage`](/documentation/Foundation/URLResourceValues/volumeAvailableCapacityForOpportunisticUsage)

The volume’s available capacity for storing nonessential resources, in bytes.

[`volumeTotalCapacity`](/documentation/Foundation/URLResourceValues/volumeTotalCapacity)

The volume’s total capacity, in bytes.

### Volume status values

[`volumeIsAutomounted`](/documentation/Foundation/URLResourceValues/volumeIsAutomounted)

A Boolean value that indicates whether the volume is automounted.

[`volumeIsBrowsable`](/documentation/Foundation/URLResourceValues/volumeIsBrowsable)

A Boolean value that indicates whether the volume is visible through the user interface.

[`volumeIsEjectable`](/documentation/Foundation/URLResourceValues/volumeIsEjectable)

A Boolean value that indicates whether the volume’s media is ejectable from the drive mechanism under software control.

[`volumeIsEncrypted`](/documentation/Foundation/URLResourceValues/volumeIsEncrypted)

A Boolean value that indicates whether the volume is encrypted.

[`volumeIsInternal`](/documentation/Foundation/URLResourceValues/volumeIsInternal)

A Boolean value that indicates whether the volume’s device is connected to an internal bus, or nil if not available.

[`volumeIsJournaling`](/documentation/Foundation/URLResourceValues/volumeIsJournaling)

A Boolean value that indicates whether the volume is currently using a journal for speedy recovery after an unplanned restart.

[`volumeIsLocal`](/documentation/Foundation/URLResourceValues/volumeIsLocal)

A Boolean value that indicates whether the volume is on a local device.

[`volumeIsReadOnly`](/documentation/Foundation/URLResourceValues/volumeIsReadOnly)

A Boolean value that indicates whether the volume is read-only.

[`volumeIsRemovable`](/documentation/Foundation/URLResourceValues/volumeIsRemovable)

A Boolean value that indicates whether the volume’s media is removable from the drive mechanism.

[`volumeIsRootFileSystem`](/documentation/Foundation/URLResourceValues/volumeIsRootFileSystem)

A Boolean value that indicates whether the volume is the root file system.

[`volumeTypeName`](/documentation/Foundation/URLResourceValues/volumeTypeName)

The volume’s type name, as a string.

[`volumeSubtype`](/documentation/Foundation/URLResourceValues/volumeSubtype)

An integer value that indicates the file system subtype.

[`volumeMountFromLocation`](/documentation/Foundation/URLResourceValues/volumeMountFromLocation)

The file system device location, as a string.

### Volume support values

[`isMountTrigger`](/documentation/Foundation/URLResourceValues/isMountTrigger)

A Boolean value that indicates whether this URL is a file system trigger directory.

[`isVolume`](/documentation/Foundation/URLResourceValues/isVolume)

A Boolean value that indicates whether the root directory is a volume.

[`volume`](/documentation/Foundation/URLResourceValues/volume)

URL of the volume on which the resource is stored.

[`volumeCreationDate`](/documentation/Foundation/URLResourceValues/volumeCreationDate)

The volume’s creation date, or `nil` if this cannot be determined.

[`volumeIdentifier`](/documentation/Foundation/URLResourceValues/volumeIdentifier)

An identifier that identifies the volume the file system object is on.

[`volumeLocalizedFormatDescription`](/documentation/Foundation/URLResourceValues/volumeLocalizedFormatDescription)

The volume format that’s visible to the user.

[`volumeLocalizedName`](/documentation/Foundation/URLResourceValues/volumeLocalizedName)

The name of the volume that’s visible to the user.

[`volumeMaximumFileSize`](/documentation/Foundation/URLResourceValues/volumeMaximumFileSize)

The largest file size supported by this file system, in bytes, or `nil` if this cannot be determined.

[`volumeName`](/documentation/Foundation/URLResourceValues/volumeName)

The name of the volume.

[`volumeResourceCount`](/documentation/Foundation/URLResourceValues/volumeResourceCount)

The total number of resources on the volume.

[`volumeSupportsAccessPermissions`](/documentation/Foundation/URLResourceValues/volumeSupportsAccessPermissions)

A Boolean value that indicates whether the volume supports setting standard access permissions.

[`volumeSupportsAdvisoryFileLocking`](/documentation/Foundation/URLResourceValues/volumeSupportsAdvisoryFileLocking)

A Boolean value that indicates whether the volume implements whole-file flock(2) style advisory locks, and the O_EXLOCK and O_SHLOCK flags of the open(2) call.

[`volumeSupportsCasePreservedNames`](/documentation/Foundation/URLResourceValues/volumeSupportsCasePreservedNames)

A Boolean value that indicates whether the volume format preserves the case of file and directory names.

[`volumeSupportsCaseSensitiveNames`](/documentation/Foundation/URLResourceValues/volumeSupportsCaseSensitiveNames)

A Boolean value that indicates whether the volume format treats upper and lower case characters in file and directory names as different.

[`volumeSupportsCompression`](/documentation/Foundation/URLResourceValues/volumeSupportsCompression)

A Boolean value that indicates whether the volume supports transparent decompression of compressed files using decmpfs.

[`volumeSupportsExclusiveRenaming`](/documentation/Foundation/URLResourceValues/volumeSupportsExclusiveRenaming)

A Boolean value that indicates whether the volume warns of a pre-existing destination when renaming a file.

[`volumeSupportsExtendedSecurity`](/documentation/Foundation/URLResourceValues/volumeSupportsExtendedSecurity)

A Boolean value that indicates whether the volume implements extended security (ACLs).

[`volumeSupportsFileCloning`](/documentation/Foundation/URLResourceValues/volumeSupportsFileCloning)

A Boolean value that indicates whether the volume supports file cloning.

[`volumeSupportsHardLinks`](/documentation/Foundation/URLResourceValues/volumeSupportsHardLinks)

A Boolean value that indicates whether the volume format supports hard links.

[`volumeSupportsImmutableFiles`](/documentation/Foundation/URLResourceValues/volumeSupportsImmutableFiles)

A Boolean value that indicates whether the volume supports making files immutable.

[`volumeSupportsJournaling`](/documentation/Foundation/URLResourceValues/volumeSupportsJournaling)

A Boolean value that indicates whether the volume format supports a journal used to speed recovery in case of unplanned restart (such as a power outage or crash).

[`volumeSupportsPersistentIDs`](/documentation/Foundation/URLResourceValues/volumeSupportsPersistentIDs)

A Boolean value that indicates whether the volume format supports persistent object identifiers and can look up file system objects by their IDs.

[`volumeSupportsRenaming`](/documentation/Foundation/URLResourceValues/volumeSupportsRenaming)

A Boolean value that indicates whether the volume can be renamed.

[`volumeSupportsRootDirectoryDates`](/documentation/Foundation/URLResourceValues/volumeSupportsRootDirectoryDates)

A Boolean value that indicates whether the volume supports reliable storage of times for the root directory.

[`volumeSupportsSparseFiles`](/documentation/Foundation/URLResourceValues/volumeSupportsSparseFiles)

A Boolean value that indicates whether the volume format supports sparse files.

[`volumeSupportsSwapRenaming`](/documentation/Foundation/URLResourceValues/volumeSupportsSwapRenaming)

A Boolean value that indicates whether the volume supports swapping source and target files when both exist.

[`volumeSupportsSymbolicLinks`](/documentation/Foundation/URLResourceValues/volumeSupportsSymbolicLinks)

A Boolean value that indicates whether the volume format supports symbolic links.

[`volumeSupportsVolumeSizes`](/documentation/Foundation/URLResourceValues/volumeSupportsVolumeSizes)

A Boolean value that indicates whether the volume supports returning volume size values.

[`volumeSupportsZeroRuns`](/documentation/Foundation/URLResourceValues/volumeSupportsZeroRuns)

A Boolean value that indicates whether the volume keeps track of allocated but unwritten parts of a file so that it can substitute zeroes without actually writing zeroes to the media.

[`volumeURLForRemounting`](/documentation/Foundation/URLResourceValues/volumeURLForRemounting)

The `URL` needed to remount a network volume, or `nil` if not available.

[`volumeUUIDString`](/documentation/Foundation/URLResourceValues/volumeUUIDString)

The volume’s persistent `UUID` as a string, or `nil` if a persistent `UUID` is not available for the volume.

### Ubiquitous values

[`isUbiquitousItem`](/documentation/Foundation/URLResourceValues/isUbiquitousItem)

A Boolean value that indicates whether the item is in the iCloud storage.

[`ubiquitousItemIsShared`](/documentation/Foundation/URLResourceValues/ubiquitousItemIsShared)

A Boolean value that indicates a shared item.

[`ubiquitousItemIsExcludedFromSync`](/documentation/Foundation/URLResourceValues/ubiquitousItemIsExcludedFromSync)

A Boolean value that indicates the system excludes the item from syncing.

[`ubiquitousSharedItemCurrentUserPermissions`](/documentation/Foundation/URLResourceValues/ubiquitousSharedItemCurrentUserPermissions)

The current user’s permissions for the shared item.

[`ubiquitousSharedItemCurrentUserRole`](/documentation/Foundation/URLResourceValues/ubiquitousSharedItemCurrentUserRole)

The current user’s role for the shared item.

[`ubiquitousSharedItemMostRecentEditorNameComponents`](/documentation/Foundation/URLResourceValues/ubiquitousSharedItemMostRecentEditorNameComponents)

The name components of the most recent editor of the shared item.

[`ubiquitousSharedItemOwnerNameComponents`](/documentation/Foundation/URLResourceValues/ubiquitousSharedItemOwnerNameComponents)

The name components of the owner of the shared item.

[`ubiquitousItemContainerDisplayName`](/documentation/Foundation/URLResourceValues/ubiquitousItemContainerDisplayName)

The name of the item’s container as the system displays it to users.

[`ubiquitousItemDownloadRequested`](/documentation/Foundation/URLResourceValues/ubiquitousItemDownloadRequested)

A Boolean value that indicates whether the user or the system requests a download of the item.

[`ubiquitousItemDownloadingError`](/documentation/Foundation/URLResourceValues/ubiquitousItemDownloadingError)

The error when downloading the item from iCloud fails.

[`ubiquitousItemDownloadingStatus`](/documentation/Foundation/URLResourceValues/ubiquitousItemDownloadingStatus)

The download status of the item.

[`ubiquitousItemHasUnresolvedConflicts`](/documentation/Foundation/URLResourceValues/ubiquitousItemHasUnresolvedConflicts)

A Boolean value that indicates whether the item has outstanding conflicts.

[`ubiquitousItemIsDownloading`](/documentation/Foundation/URLResourceValues/ubiquitousItemIsDownloading)

A Boolean value that indicates whether the system is downloading the item.

[`ubiquitousItemIsUploaded`](/documentation/Foundation/URLResourceValues/ubiquitousItemIsUploaded)

A Boolean value that indicates whether data is present in the cloud for the item.

[`ubiquitousItemIsUploading`](/documentation/Foundation/URLResourceValues/ubiquitousItemIsUploading)

A Boolean value that indicates whether the system is uploading the item.

[`ubiquitousItemUploadingError`](/documentation/Foundation/URLResourceValues/ubiquitousItemUploadingError)

The error when uploading the item to iCloud fails.

### Thumbnail values

[`thumbnail`](/documentation/Foundation/URLResourceValues/thumbnail)

A thumbnail image of the URL.

[`thumbnailDictionary`](/documentation/Foundation/URLResourceValues/thumbnailDictionary-7jyzz)

A dictionary of UIKit image objects keyed by size.

[`thumbnailDictionary`](/documentation/Foundation/URLResourceValues/thumbnailDictionary-4ztst)

A dictionary of AppKit image objects keyed by size.

### Universal resource values

[`addedToDirectoryDate`](/documentation/Foundation/URLResourceValues/addedToDirectoryDate)

The date the resource was created, or renamed into or within its parent directory.

[`allValues`](/documentation/Foundation/URLResourceValues/allValues)

A loosely-typed dictionary containing all keys and values.

[`attributeModificationDate`](/documentation/Foundation/URLResourceValues/attributeModificationDate)

The time the resource’s attributes were last modified.

[`canonicalPath`](/documentation/Foundation/URLResourceValues/canonicalPath)

The URL’s path as a canonical absolute file system path.

[`contentAccessDate`](/documentation/Foundation/URLResourceValues/contentAccessDate)

The date the resource was last accessed.

[`contentModificationDate`](/documentation/Foundation/URLResourceValues/contentModificationDate)

The time the resource content was last modified.

[`creationDate`](/documentation/Foundation/URLResourceValues/creationDate)

The date the resource was created.

[`customIcon`](/documentation/Foundation/URLResourceValues/customIcon)

[`effectiveIcon`](/documentation/Foundation/URLResourceValues/effectiveIcon)

[`generationIdentifier`](/documentation/Foundation/URLResourceValues/generationIdentifier)

An opaque generation identifier which can be compared using `==` to determine if the data in a document has been modified.

[`hasHiddenExtension`](/documentation/Foundation/URLResourceValues/hasHiddenExtension)

True for resources whose filename extension is removed from the localized name property.

[`isAliasFile`](/documentation/Foundation/URLResourceValues/isAliasFile)

true if the resource is a Finder alias file or a symlink, false otherwise

[`isExcludedFromBackup`](/documentation/Foundation/URLResourceValues/isExcludedFromBackup)

True if resource should be excluded from backups, false otherwise.

[`isHidden`](/documentation/Foundation/URLResourceValues/isHidden)

True for resources normally not displayed to users.

[`isPackage`](/documentation/Foundation/URLResourceValues/isPackage)

True for packaged directories.

[`isReadable`](/documentation/Foundation/URLResourceValues/isReadable)

True if this process (as determined by EUID) can read the resource.

[`isSymbolicLink`](/documentation/Foundation/URLResourceValues/isSymbolicLink)

True for symlinks.

[`isSystemImmutable`](/documentation/Foundation/URLResourceValues/isSystemImmutable)

True for system-immutable resources.

[`isUserImmutable`](/documentation/Foundation/URLResourceValues/isUserImmutable)

True for user-immutable resources

[`isWritable`](/documentation/Foundation/URLResourceValues/isWritable)

True if this process (as determined by EUID) can write to the resource.

[`labelColor`](/documentation/Foundation/URLResourceValues/labelColor)

[`labelNumber`](/documentation/Foundation/URLResourceValues/labelNumber)

The label number assigned to the resource.

[`linkCount`](/documentation/Foundation/URLResourceValues/linkCount)

Number of hard links to the resource.

[`localizedLabel`](/documentation/Foundation/URLResourceValues/localizedLabel)

The user-visible label text.

[`localizedName`](/documentation/Foundation/URLResourceValues/localizedName)

Localized or extension-hidden name as displayed to users.

[`localizedTypeDescription`](/documentation/Foundation/URLResourceValues/localizedTypeDescription)

User-visible type or “kind” description.

[`name`](/documentation/Foundation/URLResourceValues/name)

The resource name provided by the file system.

[`parentDirectory`](/documentation/Foundation/URLResourceValues/parentDirectory)

The resource’s parent directory, if any.

[`path`](/documentation/Foundation/URLResourceValues/path)

The URL’s path as a file system path.

[`preferredIOBlockSize`](/documentation/Foundation/URLResourceValues/preferredIOBlockSize)

The optimal block size when reading or writing this file’s data, or nil if not available.

[`quarantineProperties`](/documentation/Foundation/URLResourceValues/quarantineProperties)

The quarantine properties as defined in LSQuarantine.h. To remove quarantine information from a file, pass `nil` as the value when setting this property.

[`tagNames`](/documentation/Foundation/URLResourceValues/tagNames)

The array of Tag names.

[`typeIdentifier`](/documentation/Foundation/URLResourceValues/typeIdentifier)

A string that represents the identifier for the type of the resource.

[`contentType`](/documentation/Foundation/URLResourceValues/contentType)

The resource’s type.

### Initializers

[`init()`](/documentation/Foundation/URLResourceValues/init())

Initializes a new resource values structure.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)