| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/Foundation.framework |
| Availability | Available in Mac OS X v10.0 and later. |
| Companion guide | |
| Declared in | NSURL.h NSURLHandle.h |
| Related sample code |
The NSURL class provides a way to manipulate URLs and the resources they reference. NSURL objects understand URLs as specified in RFCs 1808, 1738, and 2732. The litmus test for conformance to RFC 1808 is as recommended in RFC 1808—whether the first two characters of resourceSpecifier are @"//".
NSURL objects can be used to refer to files, and are the preferred way to do so. ApplicationKit objects that can read data from or write data to a file generally have methods that accept an NSURL object instead of a pathname as the file reference. NSWorkspace provides openURL: to open a location specified by a URL. To get the contents of a URL, NSString provides stringWithContentsOfURL: and NSData provides dataWithContentsOfURL:.
An NSURL object is composed of two parts—a potentially nil base URL and a string that is resolved relative to the base URL. An NSURL object whose string is fully resolved without a base is considered absolute; all others are considered relative.
The NSURL class will fail to create a new NSURL object if the path being passed is not well-formed—the path must comply with RFC 2396. Examples of cases that will not succeed are strings containing space characters and high-bit characters. Should creating an NSURL object fail, the creation methods return nil, which you must be prepared to handle. If you are creating NSURL objects using file system paths, you should use fileURLWithPath: or initFileURLWithPath:, which handle the subtle differences between URL paths and file system paths. If you wish to be tolerant of malformed path strings, you’ll need to use functions provided by the Core Foundation framework to clean up the strings.
The classes NSURLConnection and NSURLDownload define methods useful for loading URL resources in the background. See URL Loading System for more information
See also NSURL Additions Reference in the Application Kit framework, which add methods supporting pasteboards.
NSURL is “toll-free bridged” with its Core Foundation counterpart, CFURL Reference. This means that the Core Foundation type is interchangeable in function or method calls with the bridged Foundation object, providing you cast one type to the other. In an API where you see an NSURL * parameter, you can pass in a CFURLRef, and in an API where you see a CFURLRef parameter, you can pass in a pointer to an NSURL instance. This approach also applies to your concrete subclasses of NSURL. See Interchangeable Data Types for more information on toll-free bridging.
– initWithScheme:host:path:
+ URLWithString:
– initWithString:
+ URLWithString:relativeToURL:
– initWithString:relativeToURL:
+ fileURLWithPath:isDirectory:
– initFileURLWithPath:isDirectory:
+ fileURLWithPath:
– initFileURLWithPath:
+ fileURLWithPathComponents:
+ URLByResolvingBookmarkData:options:relativeToURL:bookmarkDataIsStale:error:
– initByResolvingBookmarkData:options:relativeToURL:bookmarkDataIsStale:error:
– loadResourceDataNotifyingClient:usingCache: Deprecated in Mac OS X v10.4
– propertyForKey: Deprecated in Mac OS X v10.4
– resourceDataUsingCache: Deprecated in Mac OS X v10.4
– setProperty:forKey: Deprecated in Mac OS X v10.4
– setResourceData: Deprecated in Mac OS X v10.4
– URLHandleUsingCache: Deprecated in Mac OS X v10.4
– absoluteString
– absoluteURL
– baseURL
– fragment
– host
– lastPathComponent
– parameterString
– password
– path
– pathComponents
– pathExtension
– port
– query
– relativePath
– relativeString
– resourceSpecifier
– scheme
– standardizedURL
– user
– filePathURL
– fileReferenceURL
– URLByAppendingPathComponent:
– URLByAppendingPathExtension:
– URLByDeletingLastPathComponent
– URLByDeletingPathExtension
– URLByResolvingSymlinksInPath
– URLByStandardizingPath
+ bookmarkDataWithContentsOfURL:error:
– bookmarkDataWithOptions:includingResourceValuesForKeys:relativeToURL:error:
+ writeBookmarkData:toURL:options:error:
Initializes and returns bookmark data derived from an alias file pointed to by a specified URL.
+ (NSData *)bookmarkDataWithContentsOfURL:(NSURL *)bookmarkFileURL error:(NSError **)error
The URL that points to the alias file.
The error that occurred in the case that the bookmark data cannot be derived.
The bookmark data for the alias file.
If bookmarkFileURL points to an alias file created prior to Mac OS X v10.6 that contains Alias Manager information but no bookmark data, this method synthesizes bookmark data for the file.
This method returns nil if bookmark data cannot be created.
NSURL.hInitializes and returns a newly created NSURL object as a file URL with a specified path.
+ (id)fileURLWithPath:(NSString *)path
The path that the NSURL object will represent. path should be a valid system path. If path begins with a tilde, it must first be expanded with stringByExpandingTildeInPath.
Passing nil for this parameter produces an exception.
An NSURL object initialized with path.
This method assumes that path is a directory if it ends with a slash. If path does not end with a slash, the method examines the file system to determine if path is a file or a directory. If path exists in the file system and is a directory, the method appends a trailing slash. If path does not exist in the file system, the method assumes that it represents a file and does not append a trailing slash.
As an alternative, consider using fileURLWithPath:isDirectory:, which allows you to explicitly specify whether the returned NSURL object represents a file or directory.
NSURL.hInitializes and returns a newly created NSURL object as a file URL with a specified path.
+ (id)fileURLWithPath:(NSString *)path isDirectory:(BOOL)isDir
The path that the NSURL object will represent. path should be a valid system path. If path begins with a tilde, it must first be expanded with stringByExpandingTildeInPath.
Passing nil for this parameter produces an exception.
A Boolean value that specifies whether path is treated as a directory path when resolving against relative path components. Pass YES if the path indicates a directory, NO otherwise.
An NSURL object initialized with path.
NSURL.hInitializes and returns a newly created NSURL object as a file URL with specified path components.
+ (NSURL *)fileURLWithPathComponents:(NSArray *)components
An array of path components.
Passing nil for this parameter produces an exception.
An NSURL object initialized with components.
The path components are separated by a forward slash in the returned URL.
NSURL.hReturns the resource values for properties identified by a specified array of keys contained in specified bookmark data.
+ (NSDictionary *)resourceValuesForKeys:(NSArray *)keys fromBookmarkData:(NSData *)bookmarkData
An array of names of URL resource properties.
The bookmark data the resource values are derived from.
A dictionary of the requested resource values contained in bookmarkData.
NSURL.hReturns a new URL made by resolving bookmark data.
+ (id)URLByResolvingBookmarkData:(NSData *)bookmarkData options:(NSURLBookmarkResolutionOptions)options relativeToURL:(NSURL *)relativeURL bookmarkDataIsStale:(BOOL *)isStale error:(NSError **)error
The bookmark data the URL is derived from.
Options taken into account when resolving the bookmark data.
The base URL that the bookmark data is relative to.
If YES, the bookmark data is stale.
The error that occurred in the case that the URL cannot be created.
A new URL made by resolving bookmarkData.
NSURL.hCreates and returns an NSURL object initialized with a provided string.
+ (id)URLWithString:(NSString *)URLString
The string with which to initialize the NSURL object. Must conform to RFC 2396. This method parses URLString according to RFCs 1738 and 1808.
An NSURL object initialized with URLString. If the string was malformed, returns nil.
This method expects URLString to contain any necessary percent escape codes, which are ‘:’, ‘/’, ‘%’, ‘#’, ‘;’, and ‘@’. Note that ‘%’ escapes are translated via UTF-8.
NSURL.hCreates and returns an NSURL object initialized with a base URL and a relative string.
+ (id)URLWithString:(NSString *)URLString relativeToURL:(NSURL *)baseURL
The string with which to initialize the NSURL object. May not be nil. Must conform to RFC 2396. URLString is interpreted relative to baseURL.
The base URL for the NSURL object.
An NSURL object initialized with URLString and baseURL. If URLString was malformed, returns nil.
This method expects URLString to contain any necessary percent escape codes.
NSURL.hCreates an alias file on disk at a specified location with specified bookmark data.
+ (BOOL)writeBookmarkData:(NSData *)bookmarkData toURL:(NSURL *)bookmarkFileURL options:(NSURLBookmarkFileCreationOptions)options error:(NSError **)error
The bookmark data containing information for the alias file.
The desired location of the alias file.
Options taken into account when creating the alias file.
The error that occurred in the case that the alias file cannot be created.
YES if the alias file is successfully created; otherwise, NO.
This method will produce an error if bookmarkData was not created with the NSURLBookmarkCreationSuitableForBookmarkFile option.
If bookmarkFileURL points to a directory, the alias file will be created in that directory with its name derived from the information in bookmarkData. If bookmarkFileURL points to a file, the alias file will be created with the location and name indicated by bookmarkFileURL, and its extension will be changed to .alias if it is not already.
NSURL.hReturns the string for the receiver as if it were an absolute URL.
- (NSString *)absoluteString
An absolute string for the URL. Creating by resolving the receiver's string against its base according to the algorithm given in RFC 1808.
NSURL.hReturns an absolute URL that refers to the same resource as the receiver.
- (NSURL *)absoluteURL
An absolute URL that refers to the same resource as the receiver. If the receiver is already absolute, returns self. Resolution is performed per RFC 1808.
NSURL.hReturns the base URL of the receiver.
- (NSURL *)baseURL
The base URL of the receiver. If the receiver is an absolute URL, returns nil.
NSURL.hReturns bookmark data for the URL, created with specified options and resource values.
- (NSData *)bookmarkDataWithOptions:(NSURLBookmarkCreationOptions)options includingResourceValuesForKeys:(NSArray *)keys relativeToURL:(NSURL *)relativeURL error:(NSError **)error
Options taken into account when creating the bookmark data.
An array of names of URL resource properties.
The URL that the bookmark data will be relative to.
The error that occurred in the case that the bookmark data cannot be created.
The bookmark data for the URL.
NSURL.hReturns whether the resource pointed to by a file URL can be reached.
- (BOOL)checkResourceIsReachableAndReturnError:(NSError **)error
The error that occurred in the case that the resource cannot be reached.
YES if the resource is reachable; otherwise, NO.
NSURL.hReturns a new file path URL that points to the same resource as the original URL.
- (NSURL *)filePathURL
The new file path URL.
If the original URL is a file reference URL, this method converts it to a file path URL. If the original URL is a file path URL, the returned URL is identical. If the original URL is not a file URL, this method returns nil.
NSURL.hReturns a new file reference URL that points to the same resource as the original URL.
- (NSURL *)fileReferenceURL
The new file reference URL.
If the original URL is a file path URL, this method converts it to a file reference URL. If the original URL is a file reference URL, the returned URL is identical. If the original URL is not a file URL, this method returns nil.
NSURL.hReturns the fragment of a URL conforming to RFC 1808.
- (NSString *)fragment
The fragment of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hReturns the resource value for the property identified by a given key.
- (BOOL)getResourceValue:(id *)valueforKey:(NSString *)keyerror:(NSError **)error
The value for the property identified by key.
The name of one of the URL’s resource properties.
The error that occurred in the case that the resource value cannot be retrieved.
YES if value is successfully populated; otherwise, NO.
value is set to nil if the requested resource value is not defined for the URL.
NSURL.hReturns the host of a URL conforming to RFC 1808.
- (NSString *)host
The host of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hInitializes a newly created NSURL that points to a location specified by resolving bookmark data.
- (id)initByResolvingBookmarkData:(NSData *)bookmarkDataoptions:(NSURLBookmarkResolutionOptions)optionsrelativeToURL:(NSURL *)relativeURLbookmarkDataIsStale:(BOOL *)isStaleerror:(NSError **)error
The bookmark data the URL is derived from.
Options taken into account when resolving the bookmark data.
The base URL that the bookmark data is relative to.
If YES, the bookmark data is stale.
The error that occurred in the case that the URL cannot be created.
An NSURL initialized by resolving bookmarkData.
NSURL.hInitializes a newly created NSURL referencing the local file or directory at path.
- (id)initFileURLWithPath:(NSString *)path
The path that the NSURL object will represent. path should be a valid system path. If path begins with a tilde, it must first be expanded with stringByExpandingTildeInPath.
Passing nil for this parameter produces an exception.
An NSURL object initialized with path.
Invoking this method is equivalent to invoking initWithScheme:host:path: with scheme NSFileScheme, a nil host, and path.
This method examines path in the file system to determine if it is a directory. If path is a directory, then a trailing slash is appended. If the file does not exist, it is assumed that path represents a directory and a trailing slash is appended. As an alternative, consider using initFileURLWithPath:isDirectory: which allows you to explicitly specify whether the returned NSURL represents a file or directory.
NSURL.hInitializes a newly created NSURL referencing the local file or directory at path.
- (id)initFileURLWithPath:(NSString *)path isDirectory:(BOOL)isDir
The path that the NSURL object will represent. path should be a valid system path. If path begins with a tilde, it must first be expanded with stringByExpandingTildeInPath.
Passing nil for this parameter produces an exception.
A Boolean value that specifies whether path is treated as a directory path when resolving against relative path components. Pass YES if the path indicates a directory, NO otherwise
An NSURL object initialized with path.
Invoking this method is equivalent to invoking initWithScheme:host:path: with scheme NSFileScheme, a nil host, and path.
NSURL.hInitializes a newly created NSURL with a specified scheme, host, and path.
- (id)initWithScheme:(NSString *)scheme host:(NSString *)host path:(NSString *)path
The scheme for the NSURL object.
The host for the NSURL object. May be the empty string.
The path for the NSURL object. If path begins with a tilde, it must first be expanded with stringByExpandingTildeInPath.
The newly initialized NSURL object.
NSURL.hInitializes an NSURL object with a provided string.
- (id)initWithString:(NSString *)URLString
The string with which to initialize the NSURL object. Must conform to RFC 2396. This method parses URLString according to RFCs 1738 and 1808.
An NSURL object initialized with URLString. If the string was malformed, returns nil.
This method expects URLString to contain any necessary percent escape codes, which are ‘:’, ‘/’, ‘%’, ‘#’, ‘;’, and ‘@’. Note that ‘%’ escapes are translated via UTF-8.
NSURL.hInitializes an NSURL object with a base URL and a relative string.
- (id)initWithString:(NSString *)URLString relativeToURL:(NSURL *)baseURL
The string with which to initialize the NSURL object. Must conform to RFC 2396. URLString is interpreted relative to baseURL.
The base URL for the NSURL object.
An NSURL object initialized with URLString and baseURL. If URLString was malformed, returns nil.
This method expects URLString to contain any necessary percent escape codes.
initWithString:relativeToURL: is the designated initializer for NSURL.
NSURL.hReturns a Boolean value that indicates whether the receiver and a given object are equal.
- (BOOL)isEqual:(id)anObject
The object to be compared to the receiver.
YES if the receiver and anObject are equal, otherwise NO.
This method defines what it means for instances to be equal. Two NSURLs are considered equal if and only if they return identical values for both baseURL and relativeString.
Returns whether the URL is a file reference URL.
- (BOOL)isFileReferenceURL
YES if the URL is a file reference URL; otherwise, NO.
NSURL.hReturns whether the receiver uses the file scheme.
- (BOOL)isFileURL
NSURL.hReturns the last path component of a file URL.
- (NSString *)lastPathComponent
The last path component of the URL.
NSURL.hReturns the parameter string of a URL conforming to RFC 1808.
- (NSString *)parameterString
The parameter string of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hReturns the password of a URL conforming to RFC 1808.
- (NSString *)password
The password of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hReturns the path of a URL conforming to RFC 1808.
- (NSString *)path
The path of the URL. If the receiver does not conform to RFC 1808, returns nil. If isFileURL returnsYES, the return value is suitable for input into NSFileManager or NSPathUtilities. If the path has a trailing slash it is stripped.
NSURL.hReturns the individual path components of a file URL in an array.
- (NSArray *)pathComponents
An array containing the individual path components of the URL.
NSURL.hReturns the path extension of a file URL.
- (NSString *)pathExtension
The path extension of the URL.
NSURL.hReturns the port number of a URL conforming to RFC 1808.
- (NSNumber *)port
The port number of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hReturns the query of a URL conforming to RFC 1808.
- (NSString *)query
The query of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hReturns the path of a URL conforming to RFC 1808, without resolving against the receiver’s base URL.
- (NSString *)relativePath
The relative path of the URL without resolving against the base URL. If the receiver is an absolute URL, this method returns the same value as path. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hReturns a string representation of the relative portion of the URL.
- (NSString *)relativeString
A string representation of the relative portion of the URL. If the receiver is an absolute URL this method returns the same value as absoluteString.
NSURL.hReturns the resource specifier of the URL.
- (NSString *)resourceSpecifier
The resource specifier of the URL.
NSURL.hReturns the resource values for the properties identified by specified array of keys.
- (NSDictionary *)resourceValuesForKeys:(NSArray *)keyserror:(NSError **)error
An array of names of URL resource properties.
The error that occurred in the case that one or more resource values cannot be retrieved.
A dictionary of resource values indexed by key.
If an error occurs, this method returns nil.
A key is left out of the returned dictionary if its corresponding resource value is not defined for the URL.
NSURL.hReturns the scheme of the URL.
- (NSString *)scheme
The scheme of the URL.
NSURL.hSets the resource property of the URL specified by a given key to a given value.
- (BOOL)setResourceValue:(id)value forKey:(NSString *)key error:(NSError **)error
The value for the resource property defined by key.
The name of one of the URL’s resource properties.
The error that occurred in the case that the resource value cannot be set.
YES if the resource property named key is successfully set to value; otherwise, NO.
The resource is modified synchronously.
NSURL.hSets resource properties of the URL specified by a given set of keys to a given set of values.
- (BOOL)setResourceValues:(NSDictionary *)keyedValues error:(NSError **)error
A dictionary of resource values to be set.
The error that occurred in the case that one or more resource values cannot be set.
YES if all resource values in keyedValues are successfully set; otherwise, NO.
If an error occurs during the execution of this method, error will contain an array of the resource values that were not successfully set in its userInfo dictionary.
NSURL.hReturns a new NSURL object with any instances of ".." or "." removed from its path.
- (NSURL *)standardizedURL
A new NSURL object initialized with a version of the receiver’s URL that has had any instances of ".." or "." removed from its path.
NSURL.hReturns a new URL made by appending a path component to the original URL.
- (NSURL *)URLByAppendingPathComponent:(NSString *)pathComponent
The path component to add to the URL.
A new URL with pathComponent appended.
If the original URL does not end with a forward slash and pathComponent does not begin with a forward slash, a forward slash is inserted between the two parts of the returned URL, unless the original URL is the empty string.
NSURL.hReturns a new URL made by appending a path extension to the original URL.
- (NSURL *)URLByAppendingPathExtension:(NSString *)pathExtension
The path extension to add to the URL.
A new URL with pathExtension appended.
If the original URL ends with one or more forward slashes, these are removed from the returned URL. A period is inserted between the two parts of the new URL.
NSURL.hReturns a new URL made by deleting the last path component from the original URL.
- (NSURL *)URLByDeletingLastPathComponent
A new URL with the last path component of the original URL removed.
If the original URL represents the root path, the returned URL is identical. Otherwise, if the original URL has only one path component, the new URL is the empty string.
NSURL.hReturns a new URL made by deleting the path extension, if any, from the original URL.
- (NSURL *)URLByDeletingPathExtension
A new URL with the path extension of the original URL removed.
If the original URL represents the root path, the returned URL is identical. If the URL has multiple path extensions, only the last one is removed.
NSURL.hReturns a new URL that points to the same resource as the original URL and includes no symbolic links.
- (NSURL *)URLByResolvingSymlinksInPath
A new URL that points to the same resource as the original URL and includes no symbolic links.
If the original URL has no symbolic links, the returned URL is identical to the original URL.
This method only works on URLs with the file: path scheme. This method will return an identical URL for all other URLs.
NSURL.hReturns a new URL that points to the same resource as the original URL and is an absolute path.
- (NSURL *)URLByStandardizingPath
A new URL that points to the same resource as the original URL and is an absolute path.
This method only works on URLs with the file: path scheme. This method will return an identical URL for all other URLs.
NSURL.hReturns the user portion of a URL conforming to RFC 1808.
- (NSString *)user
The user portion of the URL. If the receiver does not conform to RFC 1808, returns nil.
NSURL.hThese schemes are the ones that NSURL can parse.
NSString * const NSURLFileScheme;
NSURLFileSchemeIdentifies a URL that points to a file on a mounted volume.
Available in Mac OS X v10.0 and later.
Declared in NSURL.h.
For more information, see initWithScheme:host:path:.
Keys that are applicable to file system URLs.
NSString * const NSURLNameKey; NSString * const NSURLLocalizedNameKey; NSString * const NSURLIsRegularFileKey; NSString * const NSURLIsDirectoryKey; NSString * const NSURLIsSymbolicLinkKey; NSString * const NSURLIsVolumeKey; NSString * const NSURLIsPackageKey; NSString * const NSURLIsSystemImmutableKey; NSString * const NSURLIsUserImmutableKey; NSString * const NSURLIsHiddenKey; NSString * const NSURLHasHiddenExtensionKey; NSString * const NSURLCreationDateKey; NSString * const NSURLContentAccessDateKey; NSString * const NSURLContentModificationDateKey; NSString * const NSURLAttributeModificationDateKey; NSString * const NSURLLinkCountKey; NSString * const NSURLParentDirectoryURLKey; NSString * const NSURLVolumeURLKey; NSString * const NSURLTypeIdentifierKey; NSString * const NSURLLocalizedTypeDescriptionKey; NSString * const NSURLLabelNumberKey; NSString * const NSURLLabelColorKey; NSString * const NSURLLocalizedLabelKey; NSString * const NSURLEffectiveIconKey; NSString * const NSURLCustomIconKey;
NSURLNameKeyKey for the resource’s name in the file system, returned as an NSString object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLLocalizedNameKeyKey for the resource’s localized or extension-hidden name, retuned as an NSString object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsRegularFileKeyKey for determining whether the resource is a regular file, as opposed to a directory or a symbolic link. Returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsDirectoryKeyKey for determining whether the resource is a directory, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsSymbolicLinkKeyKey for determining whether the resource is a symbolic link, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsVolumeKeyKey for determining whether the resource is the root directory of a volume, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsPackageKeyKey for determining whether the resource is a packaged directory, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsSystemImmutableKeyKey for determining whether the resource's system immutable bit is set, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsUserImmutableKeyKey for determining whether the resource's user immutable bit is set, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsHiddenKeyKey for determining whether the resource is normally not displayed to users, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLHasHiddenExtensionKeyKey for determining whether the resource’s extension is normally removed from its localized name, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLCreationDateKeyKey for the resource’s creation date, returned as an NSDate object if the volume supports creation dates, or nil if creation dates are unsupported.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLContentAccessDateKeyKey for the last time the resource was accessed, returned as an NSDate object if the volume supports access dates, or nil if access dates are unsupported.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLContentModificationDateKeyKey for the last time the resource was modified, returned as an NSDate object if the volume supports modification dates, or nil if modification dates are unsupported.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLAttributeModificationDateKeyKey for the last time the resource’s attributes were modified, returned as an NSDate object if the volume supports attribute modification dates, or nil if attribute modification dates are unsupported.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLLinkCountKeyKey for the number of hard links to the resource, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLParentDirectoryURLKeyKey for the parent directory of the resource, returned as an NSURL object, or nil if the resource is the root directory of its volume.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeURLKeyKey for the root directory of the resource’s volume, returned as an NSURL object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLTypeIdentifierKeyKey for the resource’s uniform type identifier (UTI), returned as an NSString object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLLocalizedTypeDescriptionKeyKey for the resource’s localized type description, returned as an NSString object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLLabelNumberKeyKey for the resource’s label number, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLLabelColorKeyKey for the resource’s label color, returned as an NSColor object, or nil if the resource has no label color.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLLocalizedLabelKeyKey for the resource’s localized label text, returned as an NSString object, or nil if the resource has no localized label text.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLEffectiveIconKeyKey for the resource’s normal icon, returned as an NSImage object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLCustomIconKeyKey for the icon stored with the resource, returned as an NSImage object, or nil if the resource has no custom icon.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
Keys that apply to properties of files.
NSString * const NSURLFileSizeKey; NSString * const NSURLFileAllocatedSizeKey; NSString * const NSURLIsAliasFileKey;
NSURLFileSizeKeyKey for the file’s size in bytes, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLFileAllocatedSizeKeyKey for the total size allocated on disk for the file, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLIsAliasFileKeyKey for determining whether the file is an alias, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
Keys that apply to volumes.
NSString * const NSURLVolumeLocalizedFormatDescriptionKey; NSString * const NSURLVolumeTotalCapacityKey; NSString * const NSURLVolumeAvailableCapacityKey; NSString * const NSURLVolumeResourceCountKey; NSString * const NSURLVolumeSupportsPersistentIDsKey; NSString * const NSURLVolumeSupportsSymbolicLinksKey; NSString * const NSURLVolumeSupportsHardLinksKey; NSString * const NSURLVolumeSupportsJournalingKey; NSString * const NSURLVolumeIsJournalingKey; NSString * const NSURLVolumeSupportsSparseFilesKey; NSString * const NSURLVolumeSupportsZeroRunsKey; NSString * const NSURLVolumeSupportsCaseSensitiveNamesKey; NSString * const NSURLVolumeSupportsCasePreservedNamesKey;
NSURLVolumeLocalizedFormatDescriptionKeyKey for the volume’s descriptive format name, returned as an NSString object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeTotalCapacityKeyKey for the volume’s capacity in bytes, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeAvailableCapacityKeyKey for the volume’s available capacity in bytes, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeResourceCountKeyKey for the total number of resources on the volume, returned as an NSNumber object.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsPersistentIDsKeyKey for determining whether the volume supports persistent IDs, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsSymbolicLinksKeyKey for determining whether the volume supports symbolic links, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsHardLinksKeyKey for determining whether the volume supports hard links, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsJournalingKeyKey for determining whether the volume supports journaling, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeIsJournalingKeyKey for determining whether the volume is currently journaling, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsSparseFilesKeyKey for determining whether the volume supports sparse files, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsZeroRunsKeyKey for determining whether the volume supports zero runs, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsCaseSensitiveNamesKeyKey for determining whether the volume supports case-sensitive names, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLVolumeSupportsCasePreservedNamesKeyKey for determining whether the volume supports case-preserved names, returned as an NSNumber object with value 0 or 1.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
Options used when creating bookmark data.
enum {
NSURLBookmarkCreationPreferFileIDResolution = ( 1UL << 8 ),
NSURLBookmarkCreationMinimalBookmark = ( 1UL << 9 ),
NSURLBookmarkCreationSuitableForBookmarkFile = ( 1UL << 10 )
};
typedef NSUInteger NSURLBookmarkCreationOptions;
typedef NSUInteger NSURLBookmarkFileCreationOptions;
NSURLBookmarkCreationPreferFileIDResolutionOption for specifying that an alias created with the bookmark data prefers resolving with its embedded file ID.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLBookmarkCreationMinimalBookmarkOption for specifying that an alias created with the bookmark data be created with minimal information, which may make it smaller but still able to resolve in certain ways.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLBookmarkCreationSuitableForBookmarkFileOption for specifying that the bookmark data include properties required to create Finder alias files.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
Options used when resolving bookmark data.
enum {
NSURLBookmarkResolutionWithoutUI = ( 1UL << 8 ),
NSURLBookmarkResolutionWithoutMounting = ( 1UL << 9 )
};
typedef NSUInteger NSURLBookmarkResolutionOptions;
NSURLBookmarkResolutionWithoutUIOption for specifying that no UI feedback accompany resolution of the bookmark data.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
NSURLBookmarkResolutionWithoutMountingOption for specifying that no volume should be mounted during resolution of the bookmark data.
Available in Mac OS X v10.6 and later.
Declared in NSURL.h.
FTP-specific property keys.
NSString *NSFTPPropertyUserLoginKey; NSString *NSFTPPropertyUserPasswordKey; NSString *NSFTPPropertyActiveTransferModeKey; NSString *NSFTPPropertyFileOffsetKey; NSString *NSFTPPropertyFTPProxy;
NSFTPPropertyUserLoginKeyKey for the user login, returned as an NSString object.
The default value for this key is “anonymous”.
Available in Mac OS X v10.2 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSFTPPropertyUserPasswordKeyKey for the user password, returned as an NSString object.
The default value for this key is "NSURLHandle@apple.com".
Available in Mac OS X v10.2 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSFTPPropertyActiveTransferModeKeyKey for retrieving whether in active transfer mode, returned as a boolean wrapped in an NSNumber object.
The default value for this key is NO (passive mode).
Available in Mac OS X v10.2 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSFTPPropertyFileOffsetKeyKey for retrieving the file offset, returned as an NSNumber object. The default value for this key is zero.
Available in Mac OS X v10.2 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSFTPPropertyFTPProxyNSDictionary containing proxy information to use in place of proxy identified in SystemConfiguration.framework.
To avoid any proxy use, pass an empty dictionary.
Available in Mac OS X v10.3 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
Pass these keys to NSURLHandle’s propertyForKeyIfAvailable: to request specific data. All keys are optional. The default configuration allows an anonymous, passive-mode, one-off transfer of the specified URL.
HTTP-specific property keys.
NSString * const NSHTTPPropertyStatusCodeKey; NSString * const NSHTTPPropertyStatusReasonKey; NSString * const NSHTTPPropertyServerHTTPVersionKey; NSString * const NSHTTPPropertyRedirectionHeadersKey; NSString * const NSHTTPPropertyErrorPageDataKey; NSString * const NSHTTPPropertyHTTPProxy;
NSHTTPPropertyStatusCodeKeyKey for the status code, returned as an integer wrapped in an NSNumber object.
Available in Mac OS X v10.0 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSHTTPPropertyStatusReasonKeyKey for the remainder of the HTTP status line following the status code, returned as an NSString object.
This string usually contains an explanation of the error in English. Because this string is taken straight from the server response, it’s not localized.
Available in Mac OS X v10.0 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSHTTPPropertyServerHTTPVersionKeyKey for retrieving the HTTP version as an NSString object containing the initial server status line up to the first space.
Available in Mac OS X v10.0 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSHTTPPropertyRedirectionHeadersKeyKey for retrieving the redirection headers as an NSDictionary object with each header value keyed to the header name.
Available in Mac OS X v10.0 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSHTTPPropertyErrorPageDataKeyKey for retrieving an error page as an NSData object.
Available in Mac OS X v10.0 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
NSHTTPPropertyHTTPProxyKey for retrieving the NSDictionary object containing proxy information to use in place of proxy identified in SystemConfiguration.framework.
To avoid any proxy use, pass an empty dictionary.
Available in Mac OS X v10.2 and later.
Deprecated in Mac OS X v10.4.
Declared in NSURLHandle.h.
Pass these keys to NSURLHandle's propertyForKeyIfAvailable: to request specific data.
Last updated: 2009-10-09
