Platforms to show: All Mac Windows Linux Cross-Platform

Back to NSURLMBS class.

Previous items Next items

NSURLMBS.NSURLVolumeAvailableCapacityForOpportunisticUsageKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

Total available capacity in bytes for "Important" resources, including space expected to be cleared by purging non-essential and cached resources. "Important" means something that the user or application clearly expects to be present on the local system, but is ultimately replaceable. This would include items that the user has explicitly requested via the UI, and resources that an application requires in order to provide functionality.

Examples: A video that the user has explicitly requested to watch but has not yet finished watching or an audio file that the user has requested to download.

This value should not be used in determining if there is room for an irreplaceable resource. In the case of irreplaceable resources, always attempt to save the resource regardless of available capacity and handle failure as gracefully as possible.

Value is zero if unknown. Please switch to NSURLVolumeAvailableCapacityKey key in that case.

Read-only, value type number

Some examples using this method:

NSURLMBS.NSURLVolumeAvailableCapacityKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for the volume’s available capacity in bytes, returned as an Int64 (read-only).
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeCreationDateKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for the volume’s creation date, returned as a date, or nil if it cannot be determined (read-only).

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIdentifierKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

The unique identifier of the resource’s volume, returned as an id (read-only).
This identifier can be used with the isEqual method to determine whether two file system resources are on the same volume.
The value of this identifier is not persistent across system restarts.
Available in OS X v10.7 and later.

If used with getResourceValue will give a MemoryBlock.

Some examples using this method:

NSURLMBS.NSURLVolumeIsAutomountedKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsBrowsableKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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 (read-only).

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsEjectableKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsEncryptedKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume is encrypted. (Read-only, value type boolean)

NSURLMBS.NSURLVolumeIsInternalKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsJournalingKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for determining whether the volume is currently journaling, returned as a Boolean.
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsLocalKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.
Example
dim f as FolderItem = GetFolderItem("/Volumes/Ablage1", FolderItem.PathTypeNative)

dim n as NSURLMBS = NSURLMBS.URLWithItem(f)
dim value as Variant
dim error as NSErrorMBS

dim Local as Boolean

// network volumes are not local
if n.getResourceValue(value, n.NSURLVolumeIsLocalKey, error) then
MsgBox "Local: "+value.StringValue
Local = value.BooleanValue
else
MsgBox error.LocalizedDescription
end if

// network volumes have an URL
if n.getResourceValue(value, n.NSURLVolumeURLForRemountingKey, error) then
MsgBox "URLForRemounting: "+value.StringValue
else
MsgBox error.LocalizedDescription
end if

Key for determining whether the volume is stored on a local device, returned as a Boolean (read-only).
Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsReadOnlyKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for determining whether the volume is read-only, returned as a Boolean (read-only).
Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsRemovableKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.
Example
dim f as FolderItem = GetFolderItem("/Volumes/Test", FolderItem.PathTypeNative)

dim n as NSURLMBS = NSURLMBS.URLWithItem(f)
dim value as Variant
dim error as NSErrorMBS

if n.getResourceValue(value, n.NSURLVolumeIsRemovableKey, error) then
MsgBox "Removable: "+value.StringValue
else
MsgBox error.LocalizedDescription
end if

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeIsRootFileSystemKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume is the root filesystem. (Read-only, value type boolean)

NSURLMBS.NSURLVolumeLocalizedFormatDescriptionKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for the volume’s descriptive format name, returned as a string (read-only).
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeLocalizedNameKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

The name of the volume as it should be displayed in the user interface, returned as a string (read-only).
Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeMaximumFileSizeKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeNameKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeResourceCountKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for the total number of resources on the volume, returned as an integer (read-only).
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeSupportsAccessPermissionsKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume supports setting POSIX access permissions with the NSURLFileSecurityKey property (Read-only, value type boolean)

NSURLMBS.NSURLVolumeSupportsAdvisoryFileLockingKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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).

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeSupportsCasePreservedNamesKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.
Example
dim f as FolderItem = Volume(0)
dim n as new NSURLMBS(f)

dim v as Variant
dim e as NSErrorMBS
if n.getResourceValue(v, n.NSURLVolumeSupportsCasePreservedNamesKey, e) then
MsgBox "VolumeSupportsCasePreservedNames: "+str(v.BooleanValue)
else
MsgBox "Failed to query: "+e.LocalizedDescription
end if

Key for determining whether the volume supports case-preserved names, returned as a Boolean (read-only).
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeSupportsCaseSensitiveNamesKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.
Example
dim f as FolderItem = Volume(0)
dim n as new NSURLMBS(f)

dim v as Variant
dim e as NSErrorMBS
if n.getResourceValue(v, n.NSURLVolumeSupportsCaseSensitiveNamesKey, e) then
MsgBox "VolumeSupportsCaseSensitiveNames: "+str(v.BooleanValue)
else
MsgBox "Failed to query: "+e.LocalizedDescription
end if

Key for determining whether the volume supports case-sensitive names, returned as a Boolean (read-only).
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeSupportsCompressionKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume supports transparent decompression of compressed files using decmpfs. (Read-only, value type boolean)

NSURLMBS.NSURLVolumeSupportsExclusiveRenamingKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume supports renamex_np(2)'s RENAME_EXCL option (Read-only, value type boolean)

NSURLMBS.NSURLVolumeSupportsExtendedSecurityKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

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

Available in OS X v10.7 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeSupportsFileCloningKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume supports clonefile(2) (Read-only, value type boolean)

NSURLMBS.NSURLVolumeSupportsFileProtectionKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

True if the volume supports the File Protection attribute (see NSURLFileProtectionKey). (Read-only, value type number)

NSURLMBS.NSURLVolumeSupportsHardLinksKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 15.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the property keys for volumes.

Key for determining whether the volume supports hard links, returned as a Boolean.
Available in OS X v10.6 and later.

Some examples using this method:

NSURLMBS.NSURLVolumeSupportsImmutableFilesKey as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method Cocoa Networking MBS MacBase Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
One of the file system URL resource keys.

true if the volume supports making files immutable with the NSURLIsUserImmutableKey or NSURLIsSystemImmutableKey properties (Read-only, value type boolean)

Previous items Next items

The items on this page are in the following plugins: MBS MacBase Plugin.


💬 Ask a question or report a problem
The biggest plugin in space...