Deprecated Core Foundation URL Access Utilities Functions

A function identified as deprecated has been superseded and may become unsupported in the future.

Deprecated in iOS 7.0

CFURLCreateDataAndPropertiesFromResource

Loads the data and properties referred to by a given URL. (Deprecated in iOS 7.0.)

Boolean CFURLCreateDataAndPropertiesFromResource (
   CFAllocatorRef alloc,
   CFURLRef url,
   CFDataRef *resourceData,
   CFDictionaryRef *properties,
   CFArrayRef desiredProperties,
   SInt32 *errorCode
);
Parameters
allocator

The allocator to use to allocate memory for the new CFData and CFDictionary objects returned in resourceData and properties. Pass NULL or kCFAllocatorDefault to use the current default allocator.

url

The URL referring to the data and/or properties you wish to load.

resourceData

On return, contains a CFData object containing the data referred to by url. Ownership follows the Create Rule.

properties

On return, a pointer to a CFDictionary object containing the resource properties referred to by url. Ownership follows the Create Rule.

desiredProperties

A list of the properties you wish to obtain and return in properties. See “File URL Properties” and “HTTP URL Properties” for the list of available properties.

errorCode

0 if successful, otherwise an error code indicating the nature of the problem. See “Error Codes” for a list of possible error codes.

Return Value

true if successful, false otherwise.

Discussion

If you are interested in loading only the resource data or the resource's properties, pass NULL for the one you don't want. If properties is non-NULL and desiredProperties is NULL then all properties are fetched. Note that as much work as possible is done even if false is returned. For instance, if one property is not available, the others are fetched anyway. This function is intended for convenience, not performance.

Availability
  • Available in iOS 2.0 and later.
  • Deprecated in iOS 7.0.
Declared In
CFURLAccess.h

CFURLCreatePropertyFromResource

Returns a given property specified by a given URL and property string. (Deprecated in iOS 7.0.)

CFTypeRef CFURLCreatePropertyFromResource (
   CFAllocatorRef alloc,
   CFURLRef url,
   CFStringRef property,
   SInt32 *errorCode
);
Parameters
allocator

The allocator to use to to allocate memory for the new CFType object for the requested property. Pass NULL or kCFAllocatorDefault to use the current default allocator.

url

The CFURL object referring to the resource whose properties are loaded.

property

The name of the property you wish to load. Pass one of the provided string constants indicating the property. See “File URL Properties” and “HTTP URL Properties” for the list of available properties.

errorCode

On return, 0 if successful, otherwise an error code indicating the nature of the problem. See “Error Codes” for a list of possible error codes.

Return Value

If successful, the requested property as a CFType object, NULL otherwise. Ownership follows the Create Rule.

Discussion

This is a convenience function for retrieving individual property values which calls through to CFURLCreateDataAndPropertiesFromResource.

Availability
  • Available in iOS 2.0 and later.
  • Deprecated in iOS 7.0.
Declared In
CFURLAccess.h

CFURLDestroyResource

Destroys a resource indicated by a given URL. (Deprecated in iOS 7.0.)

Boolean CFURLDestroyResource (
   CFURLRef url,
   SInt32 *errorCode
);
Parameters
url

The CFURL object of the resource to destroy.

errorCode

On return, 0 if successful, otherwise an error code indicating the nature of the problem. See “Error Codes” for a list of possible error codes.

Return Value

true if successful, false otherwise.

Discussion

If url uses an http scheme, an http DELETE request is sent to the resource. If url uses a file scheme, then:

  • if the reference is a file, the file is deleted;

  • if the reference is a directory and the directory is empty, the directory is deleted;

  • if the reference is a directory and the directory is not empty, the function returns false and errorCode contains kCFURLUnknownError.

Availability
  • Available in iOS 2.0 and later.
  • Deprecated in iOS 7.0.
Declared In
CFURLAccess.h

CFURLWriteDataAndPropertiesToResource

Writes the given data and properties to a given URL. (Deprecated in iOS 7.0.)

Boolean CFURLWriteDataAndPropertiesToResource (
   CFURLRef url,
   CFDataRef dataToWrite,
   CFDictionaryRef propertiesToWrite,
   SInt32 *errorCode
);
Parameters
url

The resource to write.

dataToWrite

The data to write. Pass NULL to write only properties.

propertiesToWrite

The properties to write. Pass NULL to write only data. See “File URL Properties” and “HTTP URL Properties” for the list of available properties.

errorCode

Upon return, 0 if successful, otherwise contains an error code indicating the nature of the problem. See “Error Codes” for a list of possible error codes.

Return Value

true if successful, false otherwise.

Discussion

Properties not present in propertiesToWrite are left unchanged, hence if propertiesToWrite is NULL or empty, the URL's properties are not changed at all.

If url uses a file scheme and it references a file, the contents of dataToWrite are written to the referenced file, overwriting any preexisting data, and the file’s properties are modified according to propertiesToWrite. If the file does not exist, but all intermediate directories along the path do already exist, the file is created (otherwise it is not).

If url uses a file scheme and it references a directory (the last path character is "/"), the contents of dataToWrite are ignored, but if the parameter value is not NULL—and all intermediate directories along the path do already exist—a new directory is created (otherwise it is not).

If url uses an http scheme, an http PUT request is sent to the resource with propertiesToWrite as the header fields and dataToWrite as the data.

Availability
  • Available in iOS 2.0 and later.
  • Deprecated in iOS 7.0.
Declared In
CFURLAccess.h