NSFileManager Class

Definition

An abstraction over the underlying file system that allows for common file discovery and manipulation actions.

[Foundation.Register("NSFileManager", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 8, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 11, 0, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.WatchOS, ObjCRuntime.PlatformArchitecture.All, null)]
[ObjCRuntime.Unavailable(ObjCRuntime.PlatformName.TvOS, ObjCRuntime.PlatformArchitecture.All, null)]
public class NSFileManager : Foundation.NSObject
type NSFileManager = class
    inherit NSObject
Inheritance
NSFileManager
Attributes

Constructors

NSFileManager()

Default constructor that initializes a new instance of this class with no parameters.

NSFileManager(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

NSFileManager(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AppendOnly

Represents the value associated with the constant NSFileAppendOnly

Busy

Represents the value associated with the constant NSFileBusy

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

CreationDate

Represents the value associated with the constant NSFileCreationDate

CurrentDirectory
DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DefaultManager

Static reference to the singleton NSFileManager.

Delegate

An instance of the Foundation.INSFileManagerDelegate model class which acts as the class delegate.

Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
DeviceIdentifier

Represents the value associated with the constant NSFileDeviceIdentifier

ExtensionHidden

Represents the value associated with the constant NSFileExtensionHidden

FileProtectionComplete

Represents the value associated with the constant NSFileProtectionComplete

FileProtectionCompleteUnlessOpen

Represents the value associated with the constant NSFileProtectionCompleteUnlessOpen

FileProtectionCompleteUntilFirstUserAuthentication

Represents the value associated with the constant NSFileProtectionCompleteUntilFirstUserAuthentication

FileProtectionKey

Represents the value associated with the constant NSFileProtectionKey

FileProtectionNone

Represents the value associated with the constant NSFileProtectionNone

GroupOwnerAccountID

Represents the value associated with the constant NSFileGroupOwnerAccountID

GroupOwnerAccountName

Represents the value associated with the constant NSFileGroupOwnerAccountName

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
HfsCreatorCode

Represents the value associated with the constant NSFileHFSCreatorCode

HfsTypeCode

Represents the value associated with the constant NSFileHFSTypeCode

Immutable

Represents the value associated with the constant NSFileImmutable

IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
ModificationDate

Represents the value associated with the constant NSFileModificationDate

NSFileType

Represents the value associated with the constant NSFileType

OwnerAccountID

Represents the value associated with the constant NSFileOwnerAccountID

OwnerAccountName

Represents the value associated with the constant NSFileOwnerAccountName

PosixPermissions

Represents the value associated with the constant NSFilePosixPermissions

ReferenceCount

Represents the value associated with the constant NSFileReferenceCount

RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self (Inherited from NSObject)
Size

Represents the value associated with the constant NSFileSize

Superclass (Inherited from NSObject)
SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
SystemFileNumber

Represents the value associated with the constant NSFileSystemFileNumber

SystemFreeNodes

Represents the value associated with the constant NSFileSystemFreeNodes

SystemFreeSize

Represents the value associated with the constant NSFileSystemFreeSize

SystemNodes

Represents the value associated with the constant NSFileSystemNodes

SystemNumber

Represents the value associated with the constant NSFileSystemNumber

SystemSize

Represents the value associated with the constant NSFileSystemSize

TypeBlockSpecial

Represents the value associated with the constant NSFileTypeBlockSpecial

TypeCharacterSpecial

Represents the value associated with the constant NSFileTypeCharacterSpecial

TypeDirectory

Represents the value associated with the constant NSFileTypeDirectory

TypeRegular

Represents the value associated with the constant NSFileTypeRegular

TypeSocket

Represents the value associated with the constant NSFileTypeSocket

TypeSymbolicLink

Represents the value associated with the constant NSFileTypeSymbolicLink

TypeUnknown

Represents the value associated with the constant NSFileTypeUnknown

UbiquityIdentityDidChangeNotification

Notification constant for UbiquityIdentityDidChange

UbiquityIdentityToken

An opaque token that represents the current iCloud identity.

WeakDelegate

An object that can respond to the delegate protocol for this type

Zone (Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)

Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method.

(Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) (Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) (Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary) (Inherited from NSObject)
BindingInfo(String) (Inherited from NSObject)
BindingOptionDescriptions(String) (Inherited from NSObject)
BindingValueClass(String) (Inherited from NSObject)
ChangeCurrentDirectory(String)

Attepts to switch the current directory to the specified path, returns success or failure.

CommitEditing() (Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr) (Inherited from NSObject)
ComponentsToDisplay(String)
ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Contents(String)
ContentsEqual(String, String)

Whether the files at the two specified paths have the same contents.

Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
Copy(NSUrl, NSUrl, NSError)

Attempts to copy the data from the srcUrl to the dstUrl, returning success or failure and encoding error (if any) in error.

Copy(String, String, NSError)

Creates a copy of this object, allocating memory from the specified zone or from the default zone if the argument is null.

CreateDirectory(NSUrl, Boolean, NSDictionary, NSError)

Attemps to create the specified directory, returning success or failure.

CreateDirectory(String, Boolean, NSDictionary, NSError)
CreateDirectory(String, Boolean, NSFileAttributes)
CreateDirectory(String, Boolean, NSFileAttributes, NSError)
CreateFile(String, NSData, NSDictionary)

Attempts to create the specified file, with the specified data and attributes, returning success or failure.

CreateFile(String, NSData, NSFileAttributes)
CreateSymbolicLink(NSUrl, NSUrl, NSError)

Attempts to create the specified symbolic link, returning success or failure, and encoding error (if any) in error.

CreateSymbolicLink(String, String, NSError)
DangerousAutorelease() (Inherited from NSObject)
DangerousRelease() (Inherited from NSObject)
DangerousRetain() (Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
DisplayName(String)

The display name for the file at the specified path.

Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean)

Releases the resources used by the NSFileManager object.

DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
EvictUbiquitous(NSUrl, NSError)

Removes the local copy of the specified cloud-based item, returning success or failure.

ExposedBindings() (Inherited from NSObject)
FileExists(String)

Whether the specified file exists.

FileExists(String, Boolean)
FromAuthorization(NSWorkspaceAuthorization)
GetAttributes(String)
GetAttributes(String, NSError)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetContainerUrl(String)

The container directory for the specified security group ientifier.

GetCurrentDirectory()

The program's current directory.

GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetDirectoryContent(NSUrl, NSArray, NSDirectoryEnumerationOptions, NSError)
GetDirectoryContent(String, NSError)
GetDirectoryContentRecursive(String, NSError)
GetEnumerator(NSUrl, NSString[], NSDirectoryEnumerationOptions, NSEnumerateErrorHandler)
GetEnumerator(String)
GetFileProviderServices(NSUrl, Action<NSDictionary<NSString,NSFileProviderService>,NSError>)
GetFileProviderServicesAsync(NSUrl)
GetFileSystemAttributes(String)

Returns the file system attributes for a given volume.

GetFileSystemAttributes(String, NSError)

Returns the file system attributes for a given volume.

GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) (Inherited from NSObject)
GetMountedVolumes(NSArray, NSVolumeEnumerationOptions)

URLs of the mounted volumes on the device.

GetMountedVolumes(NSString[], NSVolumeEnumerationOptions)
GetNativeField(String) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
GetRelationship(NSUrlRelationship, NSSearchPathDirectory, NSSearchPathDomain, NSUrl, NSError)
GetRelationship(NSUrlRelationship, NSUrl, NSUrl, NSError)
GetSkipBackupAttribute(String)

Returns the status of the SkipBackup to iCloud attribute is set on the file.

GetSkipBackupAttribute(String, NSError)

Returns the status of the SkipBackup to iCloud attribute is set on the file.

GetSymbolicLinkDestination(String, NSError)

The path to which the symbolic link points.

GetUrl(NSSearchPathDirectory, NSSearchPathDomain, NSUrl, Boolean, NSError)

Locates and optionally creates the specified common directory in a domain.

GetUrlForPublishingUbiquitousItem(NSUrl, NSDate, NSError)

A URL that can be shared to provide access to a cloud-based item.

GetUrlForUbiquityContainer(String)

The URL for the ubiquity (iCloud) container associated with the specified containerIdentifier.

GetUrls(NSSearchPathDirectory, NSSearchPathDomain)

Returns a list of commonly used directories matching the type of directory and the domain to search for.

Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
Invoke(Action, Double) (Inherited from NSObject)
Invoke(Action, TimeSpan) (Inherited from NSObject)
InvokeOnMainThread(Action) (Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsDeletableFile(String)

Whether the file at the specified path can be deleted.

IsEqual(NSObject) (Inherited from NSObject)
IsExecutableFile(String)

Whether the file at the specified path is executable.

IsKindOfClass(Class) (Inherited from NSObject)
IsMemberOfClass(Class) (Inherited from NSObject)
IsReadableFile(String)

Whether the file at the specified path is readable.

IsUbiquitous(NSUrl)

Whether the specified item is targeted for storage on iCloud.

IsWritableFile(String)

Whether the file at the specified path is writable.

Link(NSUrl, NSUrl, NSError)

Attempts to create a hard link between the specified NSUrls, returning success or failure and populating the error parameter.

Link(String, String, NSError)
MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
Move(NSUrl, NSUrl, NSError)

Synchronously attempts to move the file from srcUrl to dstUrl, returning success or failure and setting the error parameter.

Move(String, String, NSError)
MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) (Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)

Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter.

(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PrepareForInterfaceBuilder() (Inherited from NSObject)
Remove(NSUrl, NSError)

Attempts to remove the item at the specified url, returning success or failure and setting the error parameter.

Remove(String, NSError)
RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
Replace(NSUrl, NSUrl, String, NSFileManagerItemReplacementOptions, NSUrl, NSError)

Attempts to replace the specified originalItem with the newItem, in a manner that does not lose data, returning success or faiure and setting the error parameter.

RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SetAttributes(NSDictionary, String, NSError)

Attempts to set the attributes of the file at the specified path, returning success or failure and setting the error parameter.

SetAttributes(NSFileAttributes, String)
SetAttributes(NSFileAttributes, String, NSError)
SetNativeField(String, NSObject) (Inherited from NSObject)
SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetSkipBackupAttribute(String, Boolean)
SetUbiquitous(Boolean, NSUrl, NSUrl, NSError)

Attempts to set whether the item at the specified url should be stored in iCloud, returning success or failure and setting the error parameter.

SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)

Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
StartDownloadingUbiquitous(NSUrl, NSError)

Attempts to start downloading the specified item from iCloud, returning success or failure and setting the error parameter.

Subpaths(String)

An array of strings representing the paths to all items at the specified path.

ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
TrashItem(NSUrl, NSUrl, NSError)
Unbind(NSString) (Inherited from NSObject)
Unbind(String) (Inherited from NSObject)
UnmountVolume(NSUrl, NSFileManagerUnmountOptions, Action<NSError>)
UnmountVolumeAsync(NSUrl, NSFileManagerUnmountOptions)
ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString)

Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException.

(Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates that the values of the specified indices in the specified key are about to change.

(Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet) (Inherited from NSObject)
WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetHomeDirectory(NSFileManager, String)
GetHomeDirectoryForCurrentUser(NSFileManager)
GetTemporaryDirectory(NSFileManager)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also