Top Level Namespace

Defined Under Namespace

Constant Summary

AVAssetExportSessionStatusUnknown Indicates that the status is unknown.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportSessionStatusWaiting Indicates that the session is waiting to export more data.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportSessionStatusExporting Indicates that the export session is in progress.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportSessionStatusCompleted Indicates that the export session completed successfully.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportSessionStatusFailed Indicates that the export session failed.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportSessionStatusCancelled Indicates that the export session was cancelled.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPresetLowQuality Specifies a low quality quicktime file.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPresetMediumQuality Specifies a medium quality quicktime file.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPresetHighestQuality Specifies a high quality quicktime file.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPreset640x480 Specifies output at 640x480 pixels.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPreset960x540 Specifies output at 960x540 pixels.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPreset1280x720 Specifies output at 1280x720 pixels.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPreset1920x1080 Specifies output at 1920x1080 pixels.available in ios 5.0 and later.declared in avassetexportsession.h.
AVAssetExportPresetAppleM4A Specifies an audio-only .m4a file with appropriate itunes gapless playback data.available in ios 4.0 and later.declared in avassetexportsession.h.
AVAssetExportPresetPassthrough Specifies that all tracks pass through, unless it is not possible.available in ios 4.0 and later.declared in avassetexportsession.h.
NSLineBreakByWordWrapping Wrapping occurs at word boundaries, unless the word itself doesn’t fit on a single line.available in ios 6.0 and later.declared in nsparagraphstyle.h.
NSLineBreakByCharWrapping Wrapping occurs before the first character that doesn’t fit.available in ios 6.0 and later.declared in nsparagraphstyle.h.
NSLineBreakByClipping Lines are simply not drawn past the edge of the text container.available in ios 6.0 and later.declared in nsparagraphstyle.h.
NSLineBreakByTruncatingHead The line is displayed so that the end fits in the container and the missing text at the beginning of the line is indicated by an ellipsis glyph. although this mode works for multiline text, it is more often used for single line text.available in ios 6.0 and later.declared in nsparagraphstyle.h.
NSLineBreakByTruncatingTail The line is displayed so that the beginning fits in the container and the missing text at the end of the line is indicated by an ellipsis glyph. although this mode works for multiline text, it is more often used for single line text.available in ios 6.0 and later.declared in nsparagraphstyle.h.
NSLineBreakByTruncatingMiddle The line is displayed so that the beginning and end fit in the container and the missing text in the middle is indicated by an ellipsis glyph. although this mode works for multiline text, it is more often used for single line text.available in ios 6.0 and later.declared in nsparagraphstyle.h.
NSManagedObjectResultType Specifies that the request returns managed objects.available in ios 3.0 and later.declared in nsfetchrequest.h.
NSManagedObjectIDResultType Specifies that the request returns managed object ids.available in ios 3.0 and later.declared in nsfetchrequest.h.
NSDictionaryResultType Specifies that the request returns dictionaries.see also includespendingchanges and setpropertiestofetch:.available in ios 3.0 and later.declared in nsfetchrequest.h.
NSCountResultType Specifies that the request returns the count of the objects that match the request.available in ios 5.0 and later.declared in nsfetchrequest.h.
NSSnapshotEventUndoInsertion Specifies a change due to undo from insertion.available in ios 3.0 and later.declared in nsmanagedobject.h.
NSSnapshotEventUndoDeletion Specifies a change due to undo from deletion.available in ios 3.0 and later.declared in nsmanagedobject.h.
NSSnapshotEventUndoUpdate Specifies a change due to a property-level undo.available in ios 3.0 and later.declared in nsmanagedobject.h.
NSSnapshotEventRollback Specifies a change due to the managed object context being rolled back.available in ios 3.0 and later.declared in nsmanagedobject.h.
NSSnapshotEventRefresh Specifies a change due to the managed object being refreshed.available in ios 3.0 and later.declared in nsmanagedobject.h.
NSSnapshotEventMergePolicy Specifies a change due to conflict resolution during a save operation.available in ios 3.0 and later.declared in nsmanagedobject.h.
NSInsertedObjectsKey Key for the set of objects that were inserted into the context.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSUpdatedObjectsKey Key for the set of objects that were updated.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSDeletedObjectsKey Key for the set of objects that were marked for deletion during the previous event. available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSRefreshedObjectsKey Key for the set of objects that were refreshed.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSInvalidatedObjectsKey Key for the set of objects that were invalidated.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSInvalidatedAllObjectsKey Key that specifies that all objects in the context have been invalidated.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSConfinementConcurrencyType Specifies that the context will use the thread confinement pattern.available in ios 5.0 and later.declared in nsmanagedobjectcontext.h.
NSPrivateQueueConcurrencyType Specifies that the context will be associated with a private dispatch queue.available in ios 5.0 and later.declared in nsmanagedobjectcontext.h.
NSMainQueueConcurrencyType Specifies that the context will be associated with the main queue.available in ios 5.0 and later.declared in nsmanagedobjectcontext.h.
NSSQLiteStoreType The sqlite database store type.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSBinaryStoreType The binary store type.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSInMemoryStoreType The in-memory store type.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSStoreTypeKey The key in the metadata dictionary to identify the store type.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSStoreUUIDKey The key in the metadata dictionary to identify the store uuid.the store uuid is useful to identify stores through uri representations, but it is not guaranteed to be unique. the uuid generated for new stores is unique—users can freely copy files and thus the uuid stored inside—so if you track or reference stores explicitly you need to be aware of duplicate uuids and potentially override the uuid when a new store is added to the list of known stores in your application.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSAddedPersistentStoresKey Key for the array of stores that were added.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSRemovedPersistentStoresKey Key for the array of stores that were removed.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSUUIDChangedPersistentStoresKey Key for the array of stores whose uuids changed.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSReadOnlyPersistentStoreOption A flag that indicates whether a store is treated as read-only or not.the default value is no. available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSPersistentStoreTimeoutOption Options key that specifies the connection timeout for core data stores.the corresponding value is an nsnumber object that represents the duration in seconds that core data will wait while attempting to create a connection to a persistent store. if a connection is cannot be made within that timeframe, the operation is aborted and an error is returned.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSSQLitePragmasOption Options key for a dictionary of sqlite pragma settings with pragma values indexed by pragma names as keys.all pragma values must be specified as nsstring objects. the fullfsync and synchronous pragmas control the tradeoff between write performance (write to disk speed & cache utilization) and durability (data loss/corruption sensitivity to power interruption). for more information on pragma settings, see sqlite.org/pragma.html.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSSQLiteAnalyzeOption Option key to run an analysis of the store data to optimize indices based on statistical information when the store is added to the coordinator.this invokes sqlite's analyze command. it is ignored by stores other than the sqlite store.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSSQLiteManualVacuumOption Option key to rebuild the store file, forcing a database wide defragmentation when the store is added to the coordinator.this invokes sqlite's vacuum command. it is ignored by stores other than the sqlite store.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSPersistentStoreUbiquitousContentNameKey Option to specify that a persistent store has a given name in ubiquity.this option is required for ubiquitous content to function.available in ios 5.0 and later.declared in nspersistentstorecoordinator.h.
NSPersistentStoreUbiquitousContentURLKey Option to specify the log path to use for ubiquitous content logs.this option is required for ubiquitous content to function.available in ios 5.0 and later.declared in nspersistentstorecoordinator.h.
NSPersistentStoreFileProtectionKey Key to represent the protection class for the persistent store.backward compatibility may preclude some features. the acceptable values are those defined for the nsfileprotectionkey. the default value is nsfileprotectioncompleteuntilfirstuserauthentication for all applications built on or after ios v5.0. the default value for all older applications is nsfileprotectionnone.available in ios 5.0 and later.declared in nspersistentstorecoordinator.h.
NSIgnorePersistentStoreVersioningOption Key to ignore the built-in versioning provided by core data.the corresponding value is an nsnumber object. if the boolvalue of the number is yes, core data will not compare the version hashes between the managed object model in the coordinator and the metadata for the loaded store. (it will, however, continue to update the version hash information in the metadata.) this key and corresponding value of yes is specified by default for all applications linked on or before os x v10.4.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSMigratePersistentStoresAutomaticallyOption Key to automatically attempt to migrate versioned stores.the corresponding value is an nsnumber object. if the boolvalue of the number is yes and if the version hash information for the added store is determined to be incompatible with the model for the coordinator, core data will attempt to locate the source and mapping models in the application bundles, and perform a migration.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSInferMappingModelAutomaticallyOption Key to attempt to create the mapping model automatically.the corresponding value is an nsnumber object. if the boolvalue of the number is yes and the value of the nsmigratepersistentstoresautomaticallyoption is yes, the coordinator will attempt to infer a mapping model if none can be found.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSStoreModelVersionHashesKey Key to represent the version hash information for the model used to create the store.this key is used in the metadata for a persistent store.available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSStoreModelVersionIdentifiersKey Key to represent the version identifiers for the model used to create the store.if you add your own annotations to a model’s version identifier (see versionidentifiers), they are stored in the persistent store’s metadata. you can use this key to retrieve the identifiers from the metadata dictionaries available from nspersistentstore (metadata) and nspersistentstorecoordinator (metadataforpersistentstore: and related methods). the corresponding value is a foundation collection (an nsarray or nsset object).available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSPersistentStoreOSCompatibility Key to represent the earliest version of the operation system that the persistent store supports.the corresponding value is an nsnumber object that takes the form of the constants defined by the availability macros defined in /usr/include/availabilitymacros.h; for example 1040 represents os x version 10.4.0.backward compatibility may preclude some features. available in ios 3.0 and later.declared in nspersistentstorecoordinator.h.
NSBinarySearchingFirstEqual Specifies that the search should return the first object in the range that is equal to the given object.available in ios 4.0 and later.declared in nsarray.h.
NSBinarySearchingLastEqual Specifies that the search should return the last object in the range that is equal to the given object.available in ios 4.0 and later.declared in nsarray.h.
NSBinarySearchingInsertionIndex Returns the index at which you should insert the object in order to maintain a sorted array.available in ios 4.0 and later.declared in nsarray.h.
NSAssertionHandlerKey A key with a corresponding value in the thread dictionary.if you need to customize the behavior of nsassertionhandler, create a subclass, overriding handlefailureinmethod:object:file:linenumber:description: and handlefailureinfunction:file:linenumber:description:, and install your instance into the current thread’s attributes dictionary with this key.
NSAttributedStringEnumerationReverse Causes the enumeration to occur in reverse.available in ios 4.0 and later.declared in nsattributedstring.h.
NSAttributedStringEnumerationLongestEffectiveRangeNotRequired If nsattributedstringenumerationlongesteffectiverangenotrequired option is supplied, then the longest effective range computation is not performed; the blocks may be invoked with consecutive attribute runs that have the same value.available in ios 4.0 and later.declared in nsattributedstring.h.
NSBundleExecutableArchitectureI386 Specifies the 32-bit intel architecture.available in ios 2.0 and later.declared in nsbundle.h.
NSBundleExecutableArchitecturePPC Specifies the 32-bit powerpc architecture.available in ios 2.0 and later.declared in nsbundle.h.
NSBundleExecutableArchitectureX86_64 Specifies the 64-bit intel architecture.available in ios 2.0 and later.declared in nsbundle.h.
NSBundleExecutableArchitecturePPC64 Specifies the 64-bit powerpc architecture.available in ios 2.0 and later.declared in nsbundle.h.
NSLoadedClasses An nsarray object containing the names (as nsstring objects) of each class that was loadedavailable in ios 2.0 and later.declared in nsbundle.h.
NSEraCalendarUnit Specifies the era unit.the corresponding value is an nsinteger. equal to kcfcalendarunitera.available in ios 2.0 and later.declared in nscalendar.h.
NSYearCalendarUnit Specifies the year unit.the corresponding value is an nsinteger. equal to kcfcalendarunityear.available in ios 2.0 and later.declared in nscalendar.h.
NSMonthCalendarUnit Specifies the month unit. the corresponding value is an nsinteger. equal to kcfcalendarunitmonth.available in ios 2.0 and later.declared in nscalendar.h.
NSDayCalendarUnit Specifies the day unit. the corresponding value is an nsinteger. equal to kcfcalendarunitday.available in ios 2.0 and later.declared in nscalendar.h.
NSHourCalendarUnit Specifies the hour unit.the corresponding value is an nsinteger. equal to kcfcalendarunithour.available in ios 2.0 and later.declared in nscalendar.h.
NSMinuteCalendarUnit Specifies the minute unit.the corresponding value is an nsinteger. equal to kcfcalendarunitminute.available in ios 2.0 and later.declared in nscalendar.h.
NSSecondCalendarUnit Specifies the second unit.the corresponding value is a double. equal to kcfcalendarunitsecond.available in ios 2.0 and later.declared in nscalendar.h.
NSWeekCalendarUnit Specifies the week unit.the corresponding value is an kcfcalendarunitsecond. equal to kcfcalendarunitweek.available in ios 2.0 and later.declared in nscalendar.h.
NSWeekdayCalendarUnit Specifies the weekday unit.the corresponding value is an kcfcalendarunitsecond. equal to kcfcalendarunitweekday. the weekday units are the numbers 1 through n (where for the gregorian calendar n=7 and 1 is sunday).available in ios 2.0 and later.declared in nscalendar.h.
NSWeekdayOrdinalCalendarUnit Specifies the ordinal weekday unit. the corresponding value is an kcfcalendarunitsecond. equal to kcfcalendarunitweekdayordinal. the weekday ordinal unit describes ordinal position within the month unit of the corresponding weekday unit. for example, in the gregorian calendar a weekday ordinal unit of 2 for a weekday unit 3 indicates "the second tuesday in the month".available in ios 2.0 and later.declared in nscalendar.h.
NSQuarterCalendarUnit Specifies the quarter of the calendar as an kcfcalendarunitsecond.available in ios 4.0 and later.declared in nscalendar.h.
NSWeekOfMonthCalendarUnit Specifies the original week of a month calendar unit.available in ios 5.0 and later.declared in nscalendar.h.
NSWeekOfYearCalendarUnit Specifies the original week of the year calendar unit.available in ios 5.0 and later.declared in nscalendar.h.
NSYearForWeekOfYearCalendarUnit Specifies the year when the calendar is being interpreted as a week-based calendar. available in ios 5.0 and later.declared in nscalendar.h.
NSCalendarCalendarUnit Specifies the calendar of the calendar.available in ios 4.0 and later.declared in nscalendar.h.
NSTimeZoneCalendarUnit Specifies the time zone of the calendar as an nstimezone.available in ios 4.0 and later.declared in nscalendar.h.
NSWrapCalendarComponents Specifies that the components specified for an nsdatecomponents object should be incremented and wrap around to zero/one on overflow, but should not cause higher units to be incremented.available in ios 2.0 and later.declared in nscalendar.h.
NSOpenStepUnicodeReservedBase Specifies lower bound for a unicode character range reserved for apple’s corporate use (the range is 0xf400–0xf8ff).available in ios 2.0 and later.declared in nscharacterset.h.
NSDirectPredicateModifier A predicate to compare directly the left and right hand sides.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSAllPredicateModifier A predicate to compare all entries in the destination of a to-many relationship.the left hand side must be a collection. the corresponding predicate compares each value in the left hand side with the right hand side, and returns no when it finds the first mismatch—or yes if all match.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSAnyPredicateModifier A predicate to match with any entry in the destination of a to-many relationship.the left hand side must be a collection. the corresponding predicate compares each value in the left hand side against the right hand side and returns yes when it finds the first match—or no if no match is foundavailable in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSCaseInsensitivePredicateOption A case-insensitive predicate.you represent this option in a predicate format string using a [c] following a string operation (for example, "next" like "next").available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSDiacriticInsensitivePredicateOption A diacritic-insensitive predicate.you represent this option in a predicate format string using a [d] following a string operation (for example, “naïve” like “naive”).available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSNormalizedPredicateOption Indicates that the strings to be compared have been preprocessed.this option supersedes nscaseinsensitivepredicateoption and nsdiacriticinsensitivepredicateoption, and is intended as a performance optimization option.you represent this option in a predicate format string using a [n] following a string operation (for example, "wxyzlan" matches ".lan").available in ios 5.0 and later.declared in nscomparisonpredicate.h.
NSLocaleSensitivePredicateOption Indicates that strings to be compared using , > should be handled in a locale-aware fashion.you represent this option in a predicate format string using a [l] following one of the , > operators (for example, “straße” >[l] “strasse”).
NSLessThanPredicateOperatorType A less-than predicate. available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSLessThanOrEqualToPredicateOperatorType A less-than-or-equal-to predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSGreaterThanPredicateOperatorType A greater-than predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSGreaterThanOrEqualToPredicateOperatorType A greater-than-or-equal-to predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSEqualToPredicateOperatorType An equal-to predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSNotEqualToPredicateOperatorType A not-equal-to predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSMatchesPredicateOperatorType A full regular expression matching predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSLikePredicateOperatorType A simple subset of the matches predicate, similar in behavior to sql like.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSBeginsWithPredicateOperatorType A begins-with predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSEndsWithPredicateOperatorType An ends-with predicate.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSInPredicateOperatorType A predicate to determine if the left hand side is in the right hand side.for strings, returns yes if the left hand side is a substring of the right hand side . for collections, returns yes if the left hand side is in the right hand side .available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSCustomSelectorPredicateOperatorType A predicate that uses a custom selector that takes a single argument and returns a bool value.the selector is invoked on the left hand side with the right hand side as the argument.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSContainsPredicateOperatorType A predicate to determine if the left hand side contains the right hand side.returns yes if [lhs contains rhs]; the left hand side must be an nsexpression object that evaluates to a collectionavailable in ios 3.0 and later.declared in nscomparisonpredicate.h.
NSBetweenPredicateOperatorType A predicate to determine if the right hand side lies at or between bounds specified by the left hand side.returns yes if [lhs between rhs]; the right hand side must be an array in which the first element sets the lower bound and the second element the upper, inclusive. comparison is performed using compare: or the class-appropriate equivalent.available in ios 3.0 and later.declared in nscomparisonpredicate.h.
AVAssetWriterStatusUnknown Available in ios 4.1 and later.declared in avassetwriter.h.
AVAssetWriterStatusWriting Available in ios 4.1 and later.declared in avassetwriter.h.
AVAssetWriterStatusCompleted Available in ios 4.1 and later.declared in avassetwriter.h.
AVAssetWriterStatusFailed Available in ios 4.1 and later.declared in avassetwriter.h.
AVAssetWriterStatusCancelled Available in ios 4.1 and later.declared in avassetwriter.h.
NSDataReadingMappedIfSafe A hint indicating the file should be mapped into virtual memory, if possible and safe.available in ios 5.0 and later.declared in nsdata.h.
NSDataReadingUncached A hint indicating the file should not be stored in the file-system caches.for data being read once and discarded, this option can improve performance.available in ios 4.0 and later.declared in nsdata.h.
NSDataReadingMappedAlways Hint to map the file in if possible.this takes precedence over nsdatareadingmappedifsafe if both are given.available in ios 5.0 and later.declared in nsdata.h.
NSDataReadingMapped Deprecated name for nsdatareadingmappedifsafe.available in ios 4.0 and later.declared in nsdata.h.
NSMappedRead Deprecated name for nsdatareadingmapped.available in ios 2.0 and later.declared in nsdata.h.
NSUncachedRead Deprecated name for nsdatareadinguncached.available in ios 2.0 and later.declared in nsdata.h.
NSDataWritingAtomic A hint to write data to an auxiliary file first and then exchange the files. this option is equivalent to using a write method taking the parameter atomically:yes.available in ios 4.0 and later.declared in nsdata.h.
NSDataWritingWithoutOverwriting Hint to return prevent overwriting an existing file. cannot be combined with nsdatawritingatomic.available in ios 6.0 and later.declared in nsdata.h.
NSDataWritingFileProtectionNone A hint to set the content protection attribute of the file when writing it out. in this case, the file is not stored in an encrypted format and may be accessed at boot time and while the device is unlocked. available in ios 4.0 and later.declared in nsdata.h.
NSDataWritingFileProtectionComplete A hint to set the content protection attribute of the file when writing it out. in this case, the file is stored in an encrypted format and may be read from or written to only while the device is unlocked. at all other times, attempts to read and write the file result in failure. available in ios 4.0 and later.declared in nsdata.h.
NSDataWritingFileProtectionCompleteUnlessOpen A hint to set the content protection attribute of the file when writing it out. in this case, the file cannot be opened for reading or writing when the device is locked, although new files can be created with this class. if one of these files is open when the device is locked, reading and writing are still allowed. available in ios 5.0 and later.declared in nsdata.h.
NSDataWritingFileProtectionCompleteUntilFirstUserAuthentication A hint to set the content protection attribute of the file when writing it out. in this case, the file can be read or written to while the device is locked, but while it is booting up, they have protection equivalent to nsdatawritingfileprotectioncomplete. available in ios 5.0 and later.declared in nsdata.h.
NSDataWritingFileProtectionMask A mask to use when determining the file protection options assigned to the data.available in ios 4.0 and later.declared in nsdata.h.
NSAtomicWrite Deprecated name for nsdatawritingatomic.available in ios 2.0 and later.declared in nsdata.h.
NSDataSearchBackwards Search from the end of nsdata object.available in ios 4.0 and later.declared in nsdata.h.
NSDataSearchAnchored Search is limited to start (or end, if nsdatasearchbackwards) of nsdata object.this option performs searching only on bytes at the beginning or end of the range. no match at the beginning or end means nothing is found, even if a matching sequence of bytes occurs elsewhere in the data object.available in ios 4.0 and later.declared in nsdata.h.
NSTimeIntervalSince1970 The number of seconds from 1 january 1970 to the reference date, 1 january 2001.available in ios 2.0 and later.declared in nsdate.h.
NSUndefinedDateComponent Specifies that the component is undefined.available in ios 2.0 and later.declared in nscalendar.h.
NSDecimalNumberExactnessException The name of the exception raised if there is an exactness error.available in ios 2.0 and later.declared in nsdecimalnumber.h.
NSDecimalNumberOverflowException The name of the exception raised on overflow.available in ios 2.0 and later.declared in nsdecimalnumber.h.
NSDecimalNumberUnderflowException The name of the exception raised on underflow.available in ios 2.0 and later.declared in nsdecimalnumber.h.
NSDecimalNumberDivideByZeroException The name of the exception raised on divide by zero.available in ios 2.0 and later.declared in nsdecimalnumber.h.
NSLocalizedDescriptionKey The corresponding value is a localized string representation of the error that, if present, will be returned by localizeddescription.available in ios 2.0 and later.declared in nserror.h.
NSErrorFailingURLStringKey The corresponding value is the url that caused the error. this key is only present in the nsurlerrordomain. (deprecated. this constant is deprecated in os x v10.6, and is superseded by nsurlerrorfailingurlstringerrorkey.)this constant is deprecated in os x v10.6, and is superseded by nsurlerrorfailingurlstringerrorkey. both constants refer to the same value for backward-compatibility, but the new symbol name has a better prefix.available in ios 2.0 and later.deprecated in ios 4.0.declared in nsurlerror.h.
NSFilePathErrorKey Contains the file path of the error.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nserror.h.
NSStringEncodingErrorKey The corresponding value is an nsnumber object containing the nsstringencoding value.available in ios 2.0 and later.declared in nserror.h.
NSUnderlyingErrorKey The corresponding value is an error that was encountered in an underlying implementation and caused the error that the receiver represents to occur.available in ios 2.0 and later.declared in nserror.h.
NSURLErrorKey The corresponding value is an nsurl object.available in ios 2.0 and later.declared in nserror.h.
NSLocalizedFailureReasonErrorKey The corresponding value is a localized string representation containing the reason for the failure that, if present, will be returned by localizedfailurereason.this string provides a more detailed explanation of the error than the description.available in ios 2.0 and later.declared in nserror.h.
NSLocalizedRecoverySuggestionErrorKey The corresponding value is a string containing the localized recovery suggestion for the error.this string is suitable for displaying as the secondary message in an alert panel.available in ios 2.0 and later.declared in nserror.h.
NSLocalizedRecoveryOptionsErrorKey The corresponding value is an array containing the localized titles of buttons appropriate for displaying in an alert panel.the first string is the title of the right-most and default button, the second the one to the left, and so on. the recovery options should be appropriate for the recovery suggestion returned by localizedrecoverysuggestion.available in ios 2.0 and later.declared in nserror.h.
NSRecoveryAttempterErrorKey The corresponding value is an object that conforms to the nserrorrecoveryattempting informal protocol. the recovery attempter must be an object that can correctly interpret an index into the array returned by recoveryattempter.available in ios 2.0 and later.declared in nserror.h.
NSHelpAnchorErrorKey The corresponding value is an nsstring containing the localized help corresponding to the help button. see helpanchor for more information.available in ios 4.0 and later.declared in nserror.h.
NSURLErrorFailingURLErrorKey The corresponding value is an nsurl containing the url which caused a load to fail. this key is only present in the nsurlerrordomain.available in ios 4.0 and later.declared in nsurlerror.h.
NSURLErrorFailingURLStringErrorKey The corresponding value is an nsstring object for the url which caused a load to fail. this key is only present in the nsurlerrordomain.this constant supersedes nserrorfailingurlstringkey, which was deprecated in os x v10.6. both constants refer to the same value for backward-compatibility, but this symbol name has a better prefix.available in ios 4.0 and later.declared in nsurlerror.h.
NSURLErrorFailingURLPeerTrustErrorKey The corresponding value is the sectrustref object representing the state of a failed ssl handshake. this key is only present in the nsurlerrordomain.available in ios 3.0 and later.declared in nsurlerror.h.
NSPOSIXErrorDomain Posix/bsd errorsavailable in ios 2.0 and later.declared in nserror.h.
NSOSStatusErrorDomain Mac os 9/carbon errorsavailable in ios 2.0 and later.declared in nserror.h.
NSMachErrorDomain Mach errorsavailable in ios 2.0 and later.declared in nserror.h.
NSConstantValueExpressionType An expression that always returns the same value.available in ios 3.0 and later.declared in nsexpression.h.
NSEvaluatedObjectExpressionType An expression that always returns the parameter object itself.available in ios 3.0 and later.declared in nsexpression.h.
NSVariableExpressionType An expression that always returns whatever value is associated with the key specified by ‘variable’ in the bindings dictionary.available in ios 3.0 and later.declared in nsexpression.h.
NSKeyPathExpressionType An expression that returns something that can be used as a key path.available in ios 3.0 and later.declared in nsexpression.h.
NSFunctionExpressionType An expression that returns the result of evaluating a function.available in ios 3.0 and later.declared in nsexpression.h.
NSAggregateExpressionType An expression that defines an aggregate of nsexpression objects.available in ios 3.0 and later.declared in nsexpression.h.
NSSubqueryExpressionType An expression that filters a collection using a subpredicate.available in ios 3.0 and later.declared in nsexpression.h.
NSUnionSetExpressionType An expression that creates a union of the results of two nested expressions.available in ios 3.0 and later.declared in nsexpression.h.
NSIntersectSetExpressionType An expression that creates an intersection of the results of two nested expressions.available in ios 3.0 and later.declared in nsexpression.h.
NSMinusSetExpressionType An expression that combines two nested expression results by set subtraction.available in ios 3.0 and later.declared in nsexpression.h.
NSBlockExpressionType An expression that uses a block.available in ios 4.0 and later.declared in nsexpression.h.
NSFileHandleNotificationFileHandleItem A key in the userinfo dictionary in a nsfilehandleconnectionacceptednotification notification.the corresponding value is the nsfilehandle object representing the “near” end of a socket connection.available in ios 2.0 and later.declared in nsfilehandle.h.
NSFileHandleNotificationDataItem A key in the userinfo dictionary in a nsfilehandlereadcompletionnotification and nsfilehandlereadtoendoffilecompletionnotification.the corresponding value is an nsdata object containing the available data read from a socket connection.available in ios 2.0 and later.declared in nsfilehandle.h.
NSFileHandleOperationException Raised by nsfilehandle if attempts to determine file-handle type fail or if attempts to read from a file or channel fail.available in ios 2.0 and later.declared in nsfilehandle.h.
NSFileHandleNotificationMonitorModes Currently unused.available in ios 2.0 and later.deprecated in ios 5.0.declared in nsfilehandle.h.
NSVolumeEnumerationSkipHiddenVolumes The enumeration skips hidden volumes.available in ios 4.0 and later.declared in nsfilemanager.h.
NSVolumeEnumerationProduceFileReferenceURLs The enumeration produces file reference urls rather than path-based urls.available in ios 4.0 and later.declared in nsfilemanager.h.
NSDirectoryEnumerationSkipsSubdirectoryDescendants Perform a shallow enumeration; do not descend into directories.available in ios 4.0 and later.declared in nsfilemanager.h.
NSDirectoryEnumerationSkipsPackageDescendants Do not descend into packages.available in ios 4.0 and later.declared in nsfilemanager.h.
NSDirectoryEnumerationSkipsHiddenFiles Do not enumerate hidden files.available in ios 4.0 and later.declared in nsfilemanager.h.
NSFileManagerItemReplacementUsingNewMetadataOnly Causes nsfilemanageritemreplacementwithoutdeletingbackupitem to use metadata from the new item only and not to attempt to preserve metadata from the original item.available in ios 4.0 and later.declared in nsfilemanager.h.
NSFileManagerItemReplacementWithoutDeletingBackupItem Causes nsfilemanageritemreplacementwithoutdeletingbackupitem to leave the backup item in place after a successful replacement. the default behavior is to remove the item.available in ios 4.0 and later.declared in nsfilemanager.h.
NSFileAppendOnly The key in a file attribute dictionary whose value indicates whether the file is read-only.the corresponding value is an nsnumber object containing a boolean value.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileBusy The key in a file attribute dictionary whose value indicates whether the file is busy.the corresponding value is an nsnumber object containing a boolean value.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileCreationDate The key in a file attribute dictionary whose value indicates the file's creation date.the corresponding value is an nsdate object.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileOwnerAccountName The key in a file attribute dictionary whose value indicates the name of the file's owner.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileGroupOwnerAccountName The key in a file attribute dictionary whose value indicates the group name of the file's owner.the corresponding value is an nsstring object. available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileDeviceIdentifier The key in a file attribute dictionary whose value indicates the identifier for the device on which the file resides.the corresponding value is an nsnumber object containing an unsigned long.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileExtensionHidden The key in a file attribute dictionary whose value indicates whether the file's extension is hidden.the corresponding value is an nsnumber object containing a boolean value.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileGroupOwnerAccountID The key in a file attribute dictionary whose value indicates the file's group id.the corresponding value is an nsnumber object containing an unsigned long.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileHFSCreatorCode The key in a file attribute dictionary whose value indicates the file’s hfs creator code.the corresponding value is an nsnumber object containing an unsigned long. see “hfs file types” for possible values.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileHFSTypeCode The key in a file attribute dictionary whose value indicates the file’s hfs type code.the corresponding value is an nsnumber object containing an unsigned long. see “hfs file types” for possible values.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileImmutable The key in a file attribute dictionary whose value indicates whether the file is mutable. the corresponding value is an nsnumber object containing a boolean value.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileModificationDate The key in a file attribute dictionary whose value indicates the file's last modified date.the corresponding value is an nsdate object. available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileOwnerAccountID The key in a file attribute dictionary whose value indicates the file's owner's account id.the corresponding value is an nsnumber object containing an unsigned long.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFilePosixPermissions The key in a file attribute dictionary whose value indicates the file's posix permissions.the corresponding value is an nsnumber object. use the shortvalue method to retrieve the integer value for the permissions.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileReferenceCount The key in a file attribute dictionary whose value indicates the file's reference count.the corresponding value is an nsnumber object containing an unsigned long.the number specifies the number of hard links to a file.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSize The key in a file attribute dictionary whose value indicates the file’s size in bytes.the corresponding value is an nsnumber object containing an unsigned long long.important: if the file has a resource fork, the returned value does not include the size of the resource fork.available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSystemFileNumber The key in a file attribute dictionary whose value indicates the file's filesystem file number. the corresponding value is an nsnumber object containing an unsigned long. the value corresponds to the value of st_ino, as returned by stat(2).available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileType The key in a file attribute dictionary whose value indicates the file’s type. the corresponding value is an nsstring object (see “nsfiletype attribute values” for possible values).available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileProtectionKey The extended attribute key that identifies the protection level for this file. the corresponding value is an nsstring value. for a list of possible values, see “file protection values.” available in ios 4.0 and later.declared in nsfilemanager.h.
NSFileTypeDirectory Directoryavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileTypeRegular Regular fileavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileTypeSymbolicLink Symbolic linkavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileTypeSocket Socketavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileTypeCharacterSpecial Character special fileavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileTypeBlockSpecial Block special fileavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileTypeUnknown Unknownavailable in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSystemSize The key in a file system attribute dictionary whose value indicates the size of the file system. the corresponding value is an nsnumber object that specifies the size of the file system in bytes. the value is determined by statfs().available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSystemFreeSize The key in a file system attribute dictionary whose value indicates the amount of free space on the file system. the corresponding value is an nsnumber object that specifies the amount of free space on the file system in bytes. the value is determined by statfs().available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSystemNodes The key in a file system attribute dictionary whose value indicates the number of nodes in the file system.the corresponding value is an nsnumber object that specifies the number of nodes in the file system. available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSystemFreeNodes The key in a file system attribute dictionary dictionary whose value indicates the number of free nodes in the file system.the corresponding value is an nsnumber object that specifies the number of free nodes in the file system. available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileSystemNumber The key in a file system attribute dictionary dictionary whose value indicates the filesystem number of the file system.the corresponding value is an nsnumber object that specifies the filesystem number of the file system. the value corresponds to the value of st_dev, as returned by stat(2).available in ios 2.0 and later.declared in nsfilemanager.h.
NSFileProtectionNone The file has no special protections associated with it. it can be read from or written to at any time.available in ios 4.0 and later.declared in nsfilemanager.h.
NSFileProtectionComplete The file is stored in an encrypted format on disk and cannot be read from or written to while the device is locked or booting.available in ios 4.0 and later.declared in nsfilemanager.h.
NSFileProtectionCompleteUnlessOpen The file is stored in an encrypted format on disk and must be opened while the device is unlocked. once open, your file may continue to access the file normally, even if the user locks the device.available in ios 5.0 and later.declared in nsfilemanager.h.
NSFileProtectionCompleteUntilFirstUserAuthentication The file is stored in an encrypted format on disk and cannot be accessed until after the device has booted. after the user unlocks the device for the first time, your app can access the file and continue to access it even if the user subsequently locks the device.available in ios 5.0 and later.declared in nsfilemanager.h.
NSFoundationVersionWithFileManagerResourceForkSupport The version of the foundation framework in which nsfilemanager first supported resource forks.available in ios 2.0 and later.declared in nsfilemanager.h.
NSHTTPCookieComment An nsstring object containing the comment for the cookie.only valid for version 1 cookies and later. this header field is optional.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieCommentURL An nsurl object or nsstring object containing the comment url for the cookie.only valid for version 1 cookies or later. this header field is optional.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieDiscard An nsstring object stating whether the cookie should be discarded at the end of the session. string value must be either “true” or “false”. this header field is optional. default is “false”, unless this is cookie is version 1 or greater and a value for nshttpcookiemaximumage is not specified, in which case it is assumed “true”.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieDomain An nsstring object containing the domain for the cookie. a value must be specified for either nshttpcookiedomain or nshttpcookieoriginurl. if this header field is missing the domain is inferred from the value for nshttpcookieoriginurl.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieExpires An nsdate object or nsstring object specifying the expiration date for the cookie. this header field is only used for version 0 cookies. this header field is optional.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieMaximumAge An nsstring object containing an integer value stating how long in seconds the cookie should be kept, at most.only valid for version 1 cookies and later. default is “0”. this field is optional.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieName An nsstring object containing the name of the cookie. this field is required.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieOriginURL An nsurl or nsstring object containing the url that set this cookie. a value must be specified for either nshttpcookiedomain or nshttpcookieoriginurl.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookiePath An nsstring object containing the path for the cookie. this field is required if you are using the nshttpcookiedomain key instead of the nshttpcookieoriginurl key.if you are using the nshttpcookieoriginurl key, the path is inferred if it is not provided. the default value is “/”.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookiePort An nsstring object containing comma-separated integer values specifying the ports for the cookie.only valid for version 1 cookies or later. the default value is an empty string (““). this header field is optional.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieSecure An nsstring object indicating that the cookie should be transmitted only over secure channels.providing any value for this key indicates that the cookie should remain secure.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieValue An nsstring object containing the value of the cookie. this header field is required.available in ios 2.0 and later.declared in nshttpcookie.h.
NSHTTPCookieVersion An nsstring object that specifies the version of the cookie.must be either “0” or “1”. the default is “0”. this header field is optional.available in ios 2.0 and later.declared in nshttpcookie.h.
NSInvalidArchiveOperationException The name of the exception raised by nskeyedarchiver if there is a problem creating an archive.available in ios 2.0 and later.declared in nskeyedarchiver.h.
NSInvalidUnarchiveOperationException The name of the exception raised by nskeyedarchiver if there is a problem extracting an archive.available in ios 2.0 and later.declared in nskeyedarchiver.h.
NSLocaleLanguageDirectionUnknown The direction of the language is unknown.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleLanguageDirectionLeftToRight The language direction is from left to right.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleLanguageDirectionRightToLeft The language direction is from right to left.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleLanguageDirectionTopToBottom The language direction is from top to bottom.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleLanguageDirectionBottomToTop The language direction is from bottom to top.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleIdentifier The key for the locale identifier.the corresponding value is an nsstring object. an example value might be "es_es_preeuro".available in ios 2.0 and later.declared in nslocale.h.
NSLocaleLanguageCode The key for the locale language code.the corresponding value is an nsstring object. an example value might be "es".available in ios 2.0 and later.declared in nslocale.h.
NSLocaleCountryCode The key for the locale country code.the corresponding value is an nsstring object. an example value might be "es".available in ios 2.0 and later.declared in nslocale.h.
NSLocaleScriptCode The key for the locale script code.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleVariantCode The key for the locale variant code.the corresponding value is an nsstring object. an example value might be "preeuro".available in ios 2.0 and later.declared in nslocale.h.
NSLocaleExemplarCharacterSet The key for the exemplar character set for the locale.the corresponding value is an nscharacterset object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleCalendar The key for the calendar associated with the locale.the corresponding value is an nscalendar object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleCollationIdentifier The key for the collation associated with the locale.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleUsesMetricSystem The key for the flag that indicates whether the locale uses the metric system.the corresponding value is a boolean nsnumber object. if the value is no, you can typically assume american measurement units (for example, the statute mile).available in ios 2.0 and later.declared in nslocale.h.
NSLocaleMeasurementSystem The key for the measurement system associated with the locale.the corresponding value is an nsstring object containing a description of the measurement system used by the locale, for example “metric” or “u.s.”.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleDecimalSeparator The key for the decimal separator associated with the locale.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleGroupingSeparator The key for the numeric grouping separator associated with the locale.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleCurrencySymbol The key for the currency symbol associated with the locale.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleCurrencyCode The key for the currency code associated with the locale.the corresponding value is an nsstring object.available in ios 2.0 and later.declared in nslocale.h.
NSLocaleCollatorIdentifier The key for the collation identifier for the locale.the corresponding value is an nsstring object. if unknown, nil is returned.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleQuotationBeginDelimiterKey The key for the begin quotation symbol associated with the locale.the corresponding value is an nsstring object.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleQuotationEndDelimiterKey The key for the end quotation symbol associated with the locale.the corresponding value is an nsstring object.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleAlternateQuotationBeginDelimiterKey The key for the alternating begin quotation symbol associated with the locale. in some locales, when quotations are nested, the quotation characters alternate. thus, nslocalequotationbegindelimiterkey, then nslocalealternatequotationbegindelimiterkey, etc.the corresponding value is an nsstring object.available in ios 4.0 and later.declared in nslocale.h.
NSLocaleAlternateQuotationEndDelimiterKey The key for the alternate end quotation symbol associated with the locale. in some locales, when quotations are nested, the quotation characters alternate. thus, nslocalequotationenddelimiterkey, then nslocalealternatequotationenddelimiterkey, etc.the corresponding value is an nsstring object.available in ios 4.0 and later.declared in nslocale.h.
NSGregorianCalendar Identifier for the gregorian calendar.available in ios 2.0 and later.declared in nslocale.h.
NSBuddhistCalendar Identifier for the buddhist calendar.available in ios 2.0 and later.declared in nslocale.h.
NSChineseCalendar Identifier for the chinese calendar.available in ios 2.0 and later.declared in nslocale.h.
NSHebrewCalendar Identifier for the hebrew calendar.available in ios 2.0 and later.declared in nslocale.h.
NSIslamicCalendar Identifier for the islamic calendar.available in ios 2.0 and later.declared in nslocale.h.
NSIslamicCivilCalendar Identifier for the islamic civil calendar.available in ios 2.0 and later.declared in nslocale.h.
NSJapaneseCalendar Identifier for the japanese calendar.available in ios 2.0 and later.declared in nslocale.h.
NSRepublicOfChinaCalendar Identifier for the republic of china (taiwan) calendar.a chinese calendar can be created, and you can do calendrical calculations with it, but you should not use it for formatting as the necessary underlying functionality is not working correctly yet.available in ios 4.0 and later.declared in nslocale.h.
NSPersianCalendar Identifier for the persian calendaravailable in ios 4.0 and later.declared in nslocale.h.
NSIndianCalendar Identifier for the indian calendaravailable in ios 4.0 and later.declared in nslocale.h.
NSISO8601Calendar Identifier for the iso8601. the iso8601 calendar is not yet implemented.available in ios 4.0 and later.declared in nslocale.h.
NSMachPortDeallocateNone Do not remove any send or receive rights.available in ios 2.0 and later.declared in nsport.h.
NSMachPortDeallocateSendRight Deallocate a send right when the nsmachport object is invalidated or destroyed.available in ios 2.0 and later.declared in nsport.h.
NSMachPortDeallocateReceiveRight Remove a receive right when the nsmachport object is invalidated or destroyed.available in ios 2.0 and later.declared in nsport.h.
AVKeyValueStatusUnknown Indicates that the property status is unknown.available in ios 4.0 and later.declared in avasynchronouskeyvalueloading.h.
AVKeyValueStatusLoading Indicates that the property is not fully loaded.available in ios 4.0 and later.declared in avasynchronouskeyvalueloading.h.
AVKeyValueStatusLoaded Indicates that the property is ready for use.available in ios 4.0 and later.declared in avasynchronouskeyvalueloading.h.
AVKeyValueStatusFailed Indicates that the attempt to load the property failed.available in ios 4.0 and later.declared in avasynchronouskeyvalueloading.h.
AVKeyValueStatusCancelled Indicates that the attempt to load the property was cancelled.available in ios 4.0 and later.declared in avasynchronouskeyvalueloading.h.
NSMetadataItemFSNameKey The value is an nsstring object with the name of the item as seen in the file system.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemDisplayNameKey The value is an nsstring object with the display name of the item, which may be different then the file system name.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemURLKey The value is an nsurl object that you can use to open the file.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemPathKey The value is an nsstring object that contains the full path to the file available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemFSSizeKey The value is an nsnumber object that indicates the size (in bytes) of the file on disk.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemFSCreationDateKey The value is an nsdate object that contains the date and time that the file was created.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemFSContentChangeDateKey The value is an nsdate object that contains the date and time that the file contents last changed.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataItemIsUbiquitousKey The value is an nsnumber object that contains a boolean indicating whether the item is stored in the cloud.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemHasUnresolvedConflictsKey The value is an nsnumber object that contains a boolean indicating whether the item is currently in conflict with another version of the file somewhere else. available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemIsDownloadedKey The value is an nsnumber object that contains a boolean indicating whether the current version of the item has been downloaded and is available locally.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemIsDownloadingKey The value is an nsnumber object that contains a boolean indicating whether the item is currently being downloaded to the local device. available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemIsUploadedKey The value is an nsnumber object that contains a boolean indicating whether the item has been uploaded to the cloud. available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemIsUploadingKey The value is an nsnumber object that contains a boolean indicating whether the current version of the item is currently being uploaded to the cloud.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemPercentDownloadedKey The value is an nsnumber object that contains the percentage of the file that has already been downloaded from the cloud. the value is a double in the range 0.0 to 100.0.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataUbiquitousItemPercentUploadedKey The value is an nsnumber object that contains the percentage of the file that has already been uploaded to the cloud. the value is a double in the range 0.0 to 100.0.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataQueryUbiquitousDocumentsScope Search all files in the documents directories of the application’s icloud container directories.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataQueryUbiquitousDataScope Search all files not in the documents directories of the application’s icloud container directories.available in ios 5.0 and later.declared in nsmetadata.h.
NSMetadataQueryResultContentRelevanceAttribute Key used to retrieve an nsnumber object with a floating point value between 0.0 and 1.0 inclusive. the relevance value indicates the relevance of the content of a result object. the relevance is computed based on the value of the result itself, not on its relevance to the other results returned by the query. if the value is not computed, it is treated as an attribute on the item that does not exist.available in ios 5.0 and later.declared in nsmetadata.h.
NSNetServicesErrorCode This key identifies the error that occurred during the most recent operation. available in ios 2.0 and later.declared in nsnetservices.h.
NSNetServicesErrorDomain This key identifies the originator of the error, which is either the nsnetservice object or the mach network layer. for most errors, you should not need the value provided by this key.available in ios 2.0 and later.declared in nsnetservices.h.
NSNetServiceNoAutoRename Specifies that the network service not rename itself in the event of a name collision.available in ios 2.0 and later.declared in nsnetservices.h.
NSNumberFormatterNoStyle Specifies no style.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterDecimalStyle Specifies a decimal style format.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterCurrencyStyle Specifies a currency style format.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterPercentStyle Specifies a percent style format.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterScientificStyle Specifies a scientific style format.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterSpellOutStyle Specifies a spell-out format; for example, “23” becomes “twenty-three”.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterBehaviorDefault The number-formatter behavior set as the default for new instances. you can set the default formatter behavior with the class method setdefaultformatterbehavior:.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterBehavior10_0 The number-formatter behavior as it existed prior to os x v10.4.available in ios 2.0 through ios 2.1.declared in nsnumberformatter.h.
NSNumberFormatterBehavior10_4 The number-formatter behavior since os x v10.4.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterPadBeforePrefix Specifies that the padding should occur before the prefix.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterPadAfterPrefix Specifies that the padding should occur after the prefix.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterPadBeforeSuffix Specifies that the padding should occur before the suffix.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterPadAfterSuffix Specifies that the padding should occur after the suffix.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundCeiling Round up to next larger number with the proper number of digits after the decimal separator.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundFloor Round down to next smaller number with the proper number of digits after the decimal separator.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundDown Round down to next smaller number with the proper number of digits after the decimal separator.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundHalfEven Round the last digit, when followed by a 5, toward an even digit (.25 -> .2, .35 -> .4)available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundUp Round up to next larger number with the proper number of digits after the decimal separator.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundHalfDown Round down when a 5 follows putative last digit.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSNumberFormatterRoundHalfUp Round up when a 5 follows putative last digit.available in ios 2.0 and later.declared in nsnumberformatter.h.
NSPointerFunctionsStrongMemory Use strong write-barriers to backing store; use garbage-collected memory on copy-in.this is the default memory value.as a special case, if you do not use garbage collection and specify this value in conjunction with nspointerfunctionsobjectpersonality or nspointerfunctionsobjectpointerpersonality then the nspointerfunctions object uses retain and release.if you do not use garbage collection, and specify this value in conjunction with a valid non-object personality, it is the same as specifying nspointerfunctionsmallocmemory.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsOpaqueMemory Take no action when pointers are deleted.this is usually the preferred memory option for holding arbitrary pointers.this is essentially a no-op relinquish function; the acquire function is only used for copy-in operations. this option is unlikely a to be a good choice for objects.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsMallocMemory Use free() on removal, calloc() on copy in.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsMachVirtualMemory Use mach memory.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsWeakMemory Uses weak read and write barriers appropriate for arc or gc. using nspointerfunctionsweakmemory object references will turn to null on last release.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsObjectPersonality Use hash and isequal methods for hashing and equality comparisons, use the description method for a description.this is the default personality value.as a special case, if you do not use garbage collection and specify this value in conjunction with nspointerfunctionsstrongmemory then the nspointerfunctions object uses retain and release.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsOpaquePersonality Use shifted pointer for the hash value and direct comparison to determine equality.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsObjectPointerPersonality Use shifted pointer for the hash value and direct comparison to determine equality; use the description method for a description.as a special case, if you do not use garbage collection and specify this value in conjunction with nspointerfunctionsstrongmemory then the nspointerfunctions object uses retain and release.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsCStringPersonality Use a string hash and strcmp; c-string '%s' style description.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsStructPersonality Use a memory hash and memcmp (using a size function that you must set—see sizefunction).available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsIntegerPersonality Use unshifted value as hash and equality.available in ios 6.0 and later.declared in nspointerfunctions.h.
NSPointerFunctionsCopyIn Use the memory acquire function to allocate and copy items on input (see acquirefunction).available in ios 6.0 and later.declared in nspointerfunctions.h.
NSHPUXOperatingSystem Indicates the hp ux operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSMACHOperatingSystem Indicates the os x operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSOSF1OperatingSystem Indicates the osf/1 operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSSolarisOperatingSystem Indicates the solaris operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSSunOSOperatingSystem Indicates the sun os operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSWindows95OperatingSystem Indicates the windows 95 operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSWindowsNTOperatingSystem Indicates the windows nt operating system.available in ios 2.0 and later.declared in nsprocessinfo.h.
NSPropertyListImmutable Causes the returned property list to contain immutable objects.available in ios 2.0 and later.declared in nspropertylist.h.
NSPropertyListMutableContainers Causes the returned property list to have mutable containers but immutable leaves.available in ios 2.0 and later.declared in nspropertylist.h.
NSPropertyListMutableContainersAndLeaves Causes the returned property list to have mutable containers and leaves.available in ios 2.0 and later.declared in nspropertylist.h.
NSPropertyListOpenStepFormat Specifies the ascii property list format inherited from the openstep apis.important: the nspropertylistopenstepformat constant is not supported for writing. it can be used only for reading old-style property lists.available in ios 2.0 and later.declared in nspropertylist.h.
NSPropertyListXMLFormat_v1_0 Specifies the xml property list format.available in ios 2.0 and later.declared in nspropertylist.h.
NSPropertyListBinaryFormat_v1_0 Specifies the binary property list format.available in ios 2.0 and later.declared in nspropertylist.h.
NSDefaultRunLoopMode The mode to deal with input sources other than nsconnection objects.this is the most commonly used run-loop mode.available in ios 2.0 and later.declared in nsrunloop.h.
NSRunLoopCommonModes Objects added to a run loop using this value as the mode are monitored by all run loop modes that have been declared as a member of the set of “common“ modes; see the description of cfrunloopaddcommonmode for details.available in ios 2.0 and later.declared in nsrunloop.h.
NSStreamStatusNotOpen The stream is not open for reading or writing. this status is returned before the underlying call to open a stream but after it’s been created.available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusOpening The stream is in the process of being opened for reading or for writing. for network streams, this status might include the time after the stream was opened, but while network dns resolution is happening.available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusOpen The stream is open, but no reading or writing is occurring.available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusReading Data is being read from the stream. this status would be returned if code on another thread were to call streamstatus on the stream while a read:maxlength: call (nsinputstream) was in progress.available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusWriting Data is being written to the stream. this status would be returned if code on another thread were to call streamstatus on the stream while a write:maxlength: call (nsoutputstream) was in progress.available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusAtEnd There is no more data to read, or no more data can be written to the stream. when this status is returned, the stream is in a “non-blocking” mode and no data are available.available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusClosed The stream is closed (close has been called on it).available in ios 2.0 and later.declared in nsstream.h.
NSStreamStatusError The remote end of the connection can’t be contacted, or the connection has been severed for some other reason. available in ios 2.0 and later.declared in nsstream.h.
NSStreamEventNone No event has occurred.available in ios 2.0 and later.declared in nsstream.h.
NSStreamEventOpenCompleted The open has completed successfully.available in ios 2.0 and later.declared in nsstream.h.
NSStreamEventHasBytesAvailable The stream has bytes to be read. available in ios 2.0 and later.declared in nsstream.h.
NSStreamEventHasSpaceAvailable The stream can accept bytes for writing.available in ios 2.0 and later.declared in nsstream.h.
NSStreamEventErrorOccurred An error has occurred on the stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamEventEndEncountered The end of the stream has been reached.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSocketSecurityLevelKey The security level of the target stream. see “secure-socket layer (ssl) security level” for a list of possible values.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyConfigurationKey Value is an nsdictionary object containing socks proxy configuration information. the dictionary returned from the system configuration framework for socks proxies usually suffices. available in ios 2.0 and later.declared in nsstream.h.
NSStreamDataWrittenToMemoryStreamKey Value is an nsdata instance containing the data written to a memory stream. use this property when you have an output-stream object instantiated to collect written data in memory. the value of this property is read-only.available in ios 2.0 and later.declared in nsstream.h.
NSStreamFileCurrentOffsetKey Value is an nsnumber object containing the current absolute offset of the stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamNetworkServiceType The type of service for the stream. providing the service type allows the system to properly handle certain attributes of the stream, including routing and suspension behavior. most streams do not need to set this property. see “stream service types” for a list of possible values.available in ios 4.0 and later.declared in nsstream.h.
NSStreamSocketSSLErrorDomain The error domain used by nserror when reporting ssl errors.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSErrorDomain The error domain used by nserror when reporting socks errors.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSocketSecurityLevelNone Specifies that no security level be set for a socket stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSocketSecurityLevelSSLv2 Specifies that ssl version 2 be set as the security protocol for a socket stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSocketSecurityLevelSSLv3 Specifies that ssl version 3 be set as the security protocol for a socket stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSocketSecurityLevelTLSv1 Specifies that tls version 1 be set as the security protocol for a socket stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSocketSecurityLevelNegotiatedSSL Specifies that the highest level security protocol that can be negotiated be set as the security protocol for a socket stream.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyHostKey Value is an nsstring object that represents the socks proxy host.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyPortKey Value is an nsnumber object containing an integer that represents the port on which the proxy listens.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyVersionKey Value is either nsstreamsocksproxyversion4 or nsstreamsocksproxyversion5. if this key is not present, nsstreamsocksproxyversion5 is used by default.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyUserKey Value is an nsstring object containing the user’s name.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyPasswordKey Value is an nsstring object containing the user’s password.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyVersion4 Possible value for nsstreamsocksproxyversionkey.available in ios 2.0 and later.declared in nsstream.h.
NSStreamSOCKSProxyVersion5 Possible value for nsstreamsocksproxyversionkey.available in ios 2.0 and later.declared in nsstream.h.
NSStreamNetworkServiceTypeVoIP Specifies that the stream is providing voip service.available in ios 4.0 and later.declared in nsstream.h.
NSStreamNetworkServiceTypeVideo Specifies that the stream is providing video service.available in ios 5.0 and later.declared in nsstream.h.
NSStreamNetworkServiceTypeBackground Specifies that the stream is providing a background service.available in ios 5.0 and later.declared in nsstream.h.
NSStreamNetworkServiceTypeVoice Specifies that the stream is providing voice service.available in ios 5.0 and later.declared in nsstream.h.
NSMaximumStringLength Maximum number of characters in an nsstring object.available in ios 5.0 and later.declared in nsstring.h.
NSCaseInsensitiveSearch A case-insensitive search.available in ios 2.0 and later.declared in nsstring.h.
NSLiteralSearch Exact character-by-character equivalence.available in ios 2.0 and later.declared in nsstring.h.
NSBackwardsSearch Search from end of source string.available in ios 2.0 and later.declared in nsstring.h.
NSAnchoredSearch Search is limited to start (or end, if nsbackwardssearch) of source string.available in ios 2.0 and later.declared in nsstring.h.
NSNumericSearch Numbers within strings are compared using numeric value, that is, name2.txt
NSDiacriticInsensitiveSearch Search ignores diacritic marks.for example, ‘ö’ is equal to ‘o’.available in ios 2.0 and later.declared in nsstring.h.
NSWidthInsensitiveSearch Search ignores width differences in characters that have full-width and half-width forms, as occurs in east asian character sets.for example, with this option, the full-width latin small letter 'a' (unicode code point u+ff41) is equal to the basic latin small letter 'a' (unicode code point u+0061).available in ios 2.0 and later.declared in nsstring.h.
NSForcedOrderingSearch Comparisons are forced to return either nsorderedascending or nsordereddescending if the strings are equivalent but not strictly equal.this option gives stability when sorting. for example, “aaa” is greater than “aaa” if nscaseinsensitivesearch is specified.available in ios 2.0 and later.declared in nsstring.h.
NSRegularExpressionSearch The search string is treated as an icu-compatible regular expression. if set, no other options can apply except nscaseinsensitivesearch and nsanchoredsearch. you can use this option only with the rangeofstring:... methods and stringbyreplacingoccurrencesofstring:withstring:options:range:.available in ios 3.2 and later.declared in nsstring.h.
NSStringEncodingConversionAllowLossy Allows lossy conversion.available in ios 2.0 and later.declared in nsstring.h.
NSStringEncodingConversionExternalRepresentation Specifies an external representation (with a byte-order mark, if necessary, to indicate endianness).available in ios 2.0 and later.declared in nsstring.h.
NSCharacterConversionException Nsstring raises an nscharacterconversionexception if a string cannot be represented in a file-system or string encoding.available in ios 2.0 and later.declared in nsstring.h.
NSParseErrorException Nsstring raises an nsparseerrorexception if a string cannot be parsed as a property list.available in ios 2.0 and later.declared in nsstring.h.
NSASCIIStringEncoding Strict 7-bit ascii encoding within 8-bit chars; ascii values 0…127 only.available in ios 2.0 and later.declared in nsstring.h.
NSNEXTSTEPStringEncoding 8-bit ascii encoding with nextstep extensions.available in ios 2.0 and later.declared in nsstring.h.
NSJapaneseEUCStringEncoding 8-bit euc encoding for japanese text.available in ios 2.0 and later.declared in nsstring.h.
NSUTF8StringEncoding An 8-bit representation of unicode characters, suitable for transmission or storage by ascii-based systems.available in ios 2.0 and later.declared in nsstring.h.
NSISOLatin1StringEncoding 8-bit iso latin 1 encoding.available in ios 2.0 and later.declared in nsstring.h.
NSSymbolStringEncoding 8-bit adobe symbol encoding vector.available in ios 2.0 and later.declared in nsstring.h.
NSNonLossyASCIIStringEncoding 7-bit verbose ascii to represent all unicode characters.available in ios 2.0 and later.declared in nsstring.h.
NSShiftJISStringEncoding 8-bit shift-jis encoding for japanese text.available in ios 2.0 and later.declared in nsstring.h.
NSISOLatin2StringEncoding 8-bit iso latin 2 encoding.available in ios 2.0 and later.declared in nsstring.h.
NSUnicodeStringEncoding The canonical unicode encoding for string objects.available in ios 2.0 and later.declared in nsstring.h.
NSWindowsCP1251StringEncoding Microsoft windows codepage 1251, encoding cyrillic characters; equivalent to adobestandardcyrillic font encoding.available in ios 2.0 and later.declared in nsstring.h.
NSWindowsCP1252StringEncoding Microsoft windows codepage 1252; equivalent to winlatin1.available in ios 2.0 and later.declared in nsstring.h.
NSWindowsCP1253StringEncoding Microsoft windows codepage 1253, encoding greek characters.available in ios 2.0 and later.declared in nsstring.h.
NSWindowsCP1254StringEncoding Microsoft windows codepage 1254, encoding turkish characters.available in ios 2.0 and later.declared in nsstring.h.
NSWindowsCP1250StringEncoding Microsoft windows codepage 1250; equivalent to winlatin2.available in ios 2.0 and later.declared in nsstring.h.
NSISO2022JPStringEncoding Iso 2022 japanese encoding for email.available in ios 2.0 and later.declared in nsstring.h.
NSMacOSRomanStringEncoding Classic macintosh roman encoding.available in ios 2.0 and later.declared in nsstring.h.
NSUTF16StringEncoding An alias for nsunicodestringencoding.available in ios 2.0 and later.declared in nsstring.h.
NSUTF16BigEndianStringEncoding Nsutf16stringencoding encoding with explicit endianness specified.available in ios 2.0 and later.declared in nsstring.h.
NSUTF16LittleEndianStringEncoding Nsutf16stringencoding encoding with explicit endianness specified.available in ios 2.0 and later.declared in nsstring.h.
NSUTF32StringEncoding 32-bit utf encoding.available in ios 2.0 and later.declared in nsstring.h.
NSUTF32BigEndianStringEncoding Nsutf32stringencoding encoding with explicit endianness specified.available in ios 2.0 and later.declared in nsstring.h.
NSUTF32LittleEndianStringEncoding Nsutf32stringencoding encoding with explicit endianness specified.available in ios 2.0 and later.declared in nsstring.h.
NSProprietaryStringEncoding Installation-specific encoding. (deprecated. this encoding has been deprecated—there is no replacement.)proprietary encodings have not been used since os x v10.0. you should specify a standard encoding instead.available in ios 5.0 and later.declared in nsstring.h.
NSStringEnumerationByLines Enumerates by lines. equivalent to linerangeforrange:.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationByParagraphs Enumerates by paragraphs. equivalent to paragraphrangeforrange:.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationByComposedCharacterSequences Enumerates by composed character sequences. equivalent to rangeofcomposedcharactersequencesforrange:.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationByWords Enumerates by words.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationBySentences Enumerates by sentences.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationReverse Causes enumeration to occur from the end of the specified range to the start.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationSubstringNotRequired A way to indicate that the block does not need substring, in which case nil will be passed. this is simply a performance shortcut.available in ios 4.0 and later.declared in nsstring.h.
NSStringEnumerationLocalized Causes the enumeration to occur using user's default locale. this does not make a difference in line, paragraph, or composed character sequence enumeration, but it may for words or sentences.available in ios 4.0 and later.declared in nsstring.h.
AVAssetImageGeneratorApertureModeCleanAperture Both pixel aspect ratio and clean aperture will be applied..available in ios 4.0 and later.declared in avassetimagegenerator.h.
AVAssetImageGeneratorApertureModeProductionAperture Only pixel aspect ratio will be applied.available in ios 4.0 and later.declared in avassetimagegenerator.h.
AVAssetImageGeneratorApertureModeEncodedPixels Neither pixel aspect ratio nor clean aperture will be applied.available in ios 4.0 and later.declared in avassetimagegenerator.h.
AVAssetImageGeneratorSucceeded Indicates that generation succeeded.available in ios 4.0 and later.declared in avassetimagegenerator.h.
AVAssetImageGeneratorFailed Indicates that generation failed.available in ios 4.0 and later.declared in avassetimagegenerator.h.
AVAssetImageGeneratorCancelled Indicates that generation was cancelled.available in ios 4.0 and later.declared in avassetimagegenerator.h.
NSTimeZoneNameStyleStandard Specifies a standard name style. for example, “central standard time” for central time.available in ios 2.0 and later.declared in nstimezone.h.
NSTimeZoneNameStyleShortStandard Specifies a short name style. for example, “cst” for central time.available in ios 2.0 and later.declared in nstimezone.h.
NSTimeZoneNameStyleDaylightSaving Specifies a daylight saving name style. for example, “central daylight time” for central time.available in ios 2.0 and later.declared in nstimezone.h.
NSTimeZoneNameStyleShortDaylightSaving Specifies a short daylight saving name style. for example, “cdt” for central time.available in ios 2.0 and later.declared in nstimezone.h.
NSTimeZoneNameStyleGeneric Specifies a generic name style. for example, “central time” for central time.available in ios 4.0 and later.declared in nstimezone.h.
NSTimeZoneNameStyleShortGeneric Specifies a generic time zone name. for example, “ct” for central time.available in ios 4.0 and later.declared in nstimezone.h.
NSUndoCloseGroupingRunLoopOrdering Used with nsrunloop's performselector:target:argument:order:modes:.available in ios 3.0 and later.declared in nsundomanager.h.
NSUndoManagerGroupIsDiscardableKey The key has a corresponding value of yes, wrapped as a boolean nsnumber object, if the undo group as a whole is discardable.
NSURLFileScheme Identifies a url that points to a file on a mounted volume.available in ios 2.0 through ios 5.1.declared in nsurl.h.
NSURLAttributeModificationDateKey The time at which the resource’s attributes were most recently modified, returned as an nsdate object if the volume supports attribute modification dates, or nil if attribute modification dates are unsupported.available in ios 4.0 and later.declared in nsurl.h.
NSURLContentAccessDateKey The time at which the resource was most recently accessed, returned as an nsdate object if the volume supports access dates, or nil if access dates are unsupported.available in ios 4.0 and later.declared in nsurl.h.
NSURLContentModificationDateKey The time at which the resource was most recently modified, returned as an nsdate object if the volume supports modification dates, or nil if modification dates are unsupported.available in ios 4.0 and later.declared in nsurl.h.
NSURLCreationDateKey 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 ios 4.0 and later.declared in nsurl.h.
NSURLCustomIconKey The icon stored with the resource, returned as an nsimage object, or nil if the resource has no custom icon.available in ios 4.0 and later.declared in nsurl.h.
NSURLEffectiveIconKey The resource’s normal icon, returned as an nsimage object.available in ios 4.0 and later.declared in nsurl.h.
NSURLFileResourceIdentifierKey The resource’s unique identifier, returned as an id.this identifier can be used to determine equality between file system resources with the isequal: method. two resources are equal if they have the same file-system path or if their paths link to the same inode on the same file system.the value of this identifier is not persistent across system restarts.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeKey The resource’s object type, returned as an nsstring object. see “file resource types” for possible values.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileSecurityKey The resource’s security information, returned as an nsfilesecurity object.available in ios 5.0 and later.declared in nsurl.h.
NSURLHasHiddenExtensionKey Key for determining whether the resource’s extension is normally removed from its localized name, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsDirectoryKey Key for determining whether the resource is a directory, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsExcludedFromBackupKey Key for determining whether the resource is excluded from all backups of app data, returned as a boolean nsnumber object. read/write access.you can use this property to exclude cache and other app support files which are not needed in a backup. some operations commonly made to user documents cause this property to be reset to false; consequently, do not use this property on user documents.available in ios 5.1 and later.declared in nsurl.h.
NSURLIsExecutableKey Key for determining whether the current process (as determined by the euid) can execute the resource (if it is a file) or search the resource (if it is a directory), returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLIsHiddenKey Key for determining whether the resource is normally not displayed to users, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsMountTriggerKey Key for determining whether the url is a file system trigger directory, returned as a boolean nsnumber object. traversing or opening a file system trigger directory causes an attempt to mount a file system on the directory.available in ios 5.0 and later.declared in nsurl.h.
NSURLIsPackageKey Key for determining whether the resource is a file package, returned as a boolean nsnumber object. a true value means that the resource is a file package.value is read/write. in versions of os x prior to 10.8, value is read-only.if you attempt to set or clear this key’s value on a file instead of a directory, the system ignores your attempt. if the directory is defined as a package by way of its filename extension or other reason apart from this key, setting this key’s value to false has no effect.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsReadableKey Key for determining whether the current process (as determined by the euid) can read the resource, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLIsRegularFileKey Key for determining whether the resource is a regular file, as opposed to a directory or a symbolic link. returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsSymbolicLinkKey Key for determining whether the resource is a symbolic link, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsSystemImmutableKey Key for determining whether the resource's system immutable bit is set, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsUserImmutableKey Key for determining whether the resource's user immutable bit is set, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsVolumeKey Key for determining whether the resource is the root directory of a volume, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLIsWritableKey Key for determining whether the current process (as determined by the euid) can write to the resource, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLLabelColorKey The resource’s label color, returned as an nscolor object, or nil if the resource has no label color.available in ios 4.0 and later.declared in nsurl.h.
NSURLLabelNumberKey The resource’s label number, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLLinkCountKey The number of hard links to the resource, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLLocalizedLabelKey The resource’s localized label text, returned as an nsstring object, or nil if the resource has no localized label text.available in ios 4.0 and later.declared in nsurl.h.
NSURLLocalizedNameKey The resource’s localized or extension-hidden name, returned as an nsstring object.available in ios 4.0 and later.declared in nsurl.h.
NSURLLocalizedTypeDescriptionKey The resource’s localized type description, returned as an nsstring object.available in ios 4.0 and later.declared in nsurl.h.
NSURLNameKey The resource’s name in the file system, returned as an nsstring object.available in ios 4.0 and later.declared in nsurl.h.
NSURLParentDirectoryURLKey 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 ios 4.0 and later.declared in nsurl.h.
NSURLPathKey The file system path for the url, returned a read-only nsstring object.available in ios 6.0 and later.declared in nsurl.h.
NSURLPreferredIOBlockSizeKey The optimal block size to use when reading or writing this file's data, returned as an nsnumber object, or nil if the preferred size is not available.available in ios 5.0 and later.declared in nsurl.h.
NSURLTypeIdentifierKey The resource’s uniform type identifier (uti), returned as an nsstring object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeIdentifierKey The unique identifier of the resource’s volume, returned as an id.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 ios 5.0 and later.declared in nsurl.h.
NSURLVolumeURLKey The root directory of the resource’s volume, returned as an nsurl object.available in ios 4.0 and later.declared in nsurl.h.
NSURLFileResourceTypeNamedPipe The resource is a named pipe.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeCharacterSpecial The resource is a character special file.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeDirectory The resource is a directory.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeBlockSpecial The resource is a block special file.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeRegular The resource is a regular file.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeSymbolicLink The resource is a symbolic link.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeSocket The resource is a socket.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileResourceTypeUnknown The resource’s type is unknown.available in ios 5.0 and later.declared in nsurl.h.
NSURLFileSizeKey Key for the file’s size in bytes, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLFileAllocatedSizeKey Key for the total size allocated on disk for the file, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLTotalFileSizeKey Key for the total displayable size of the file in bytes, returned as an nsnumber object. this includes the size of any file metadata.available in ios 5.0 and later.declared in nsurl.h.
NSURLTotalFileAllocatedSizeKey Key for the total allocated size of the file in bytes, returned as an nsnumber object. this includes the size of any file metadata.available in ios 5.0 and later.declared in nsurl.h.
NSURLIsAliasFileKey Key for determining whether the file is an alias, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeLocalizedFormatDescriptionKey Key for the volume’s descriptive format name, returned as an nsstring object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeTotalCapacityKey Key for the volume’s capacity in bytes, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeAvailableCapacityKey Key for the volume’s available capacity in bytes, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeResourceCountKey Key for the total number of resources on the volume, returned as an nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsPersistentIDsKey Key for determining whether the volume supports persistent ids, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsSymbolicLinksKey Key for determining whether the volume supports symbolic links, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsHardLinksKey Key for determining whether the volume supports hard links, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsJournalingKey Key for determining whether the volume supports journaling, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeIsJournalingKey Key for determining whether the volume is currently journaling, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsSparseFilesKey Key for determining whether the volume supports sparse files, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsZeroRunsKey Key for determining whether the volume supports zero runs, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsCaseSensitiveNamesKey Key for determining whether the volume supports case-sensitive names, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsCasePreservedNamesKey Key for determining whether the volume supports case-preserved names, returned as a boolean nsnumber object.available in ios 4.0 and later.declared in nsurl.h.
NSURLVolumeSupportsRootDirectoryDatesKey Key for determining whether the volume supports reliable storage of times for the root directory, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeSupportsVolumeSizesKey Key for determining whether the volume supports returning volume size information, returned as a boolean nsnumber object. if true, volume size information is available as values of the nsurlvolumetotalcapacitykey andnsurlvolumeavailablecapacitykey keys.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeSupportsRenamingKey Key for determining whether the volume can be renamed, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeSupportsAdvisoryFileLockingKey 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.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeSupportsExtendedSecurityKey Key for determining whether the volume supports extended security (access control lists), returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsBrowsableKey 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 nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeMaximumFileSizeKey Key for the largest file size supported by the volume in bytes, returned as a boolean nsnumber object, or nil if it cannot be determined.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsEjectableKey Key for determining whether the volume is ejectable from the drive mechanism under software control, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsRemovableKey Key for determining whether the volume is removable from the drive mechanism, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsInternalKey Key for determining whether the volume is connected to an internal bus, returned as a boolean nsnumber object, or nil if it cannot be determined.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsAutomountedKey Key for determining whether the volume is automounted, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsLocalKey Key for determining whether the volume is stored on a local device, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeIsReadOnlyKey Key for determining whether the volume is read-only, returned as a boolean nsnumber object.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeCreationDateKey Key for the volume’s creation date, returned as an nsdate object, or null if it cannot be determined.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeURLForRemountingKey Key for the url needed to remount the network volume, returned as an nsurl object, or nil if a url is not available.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeUUIDStringKey Key for the volume’s persistent uuid, returned as an nsstring object, or nil if a persistent uuid is not available.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeNameKey The name of the volume, returned as an nsstring object. settable if nsurlvolumesupportsrenamingkey is yes.available in ios 5.0 and later.declared in nsurl.h.
NSURLVolumeLocalizedNameKey The name of the volume as it should be displayed in the user interface, returned as an nsstring object.available in ios 5.0 and later.declared in nsurl.h.
NSURLBookmarkCreationPreferFileIDResolution Specifies that when an alias created with this option is resolved, its embedded file id should take precedence over other sources of information (file system path, for example) in the event of a conflict.available in ios 4.0 and later.declared in nsurl.h.
NSURLBookmarkCreationMinimalBookmark Specifies that an alias created with this option should be created with minimal information. this produces a smaller bookmark that can be resolved in fewer ways.available in ios 4.0 and later.declared in nsurl.h.
NSURLBookmarkCreationSuitableForBookmarkFile Specifies that the bookmark data should include properties required to create finder alias files.available in ios 4.0 and later.declared in nsurl.h.
NSURLBookmarkCreationWithSecurityScope Specifies that you want to create a security-scoped bookmark that, when resolved, provides a security-scoped url allowing read/write access to a file-system resource; for use in an app that adopts app sandbox.available in ios 6.0 and later.declared in nsurl.h.
NSURLBookmarkCreationSecurityScopeAllowOnlyReadAccess When combined with the nsurlbookmarkcreationwithsecurityscope option, specifies that you want to create a security-scoped bookmark that, when resolved, provides a security-scoped url allowing read-only access to a file-system resource; for use in an app that adopts app sandbox.available in ios 6.0 and later.declared in nsurl.h.
NSURLBookmarkResolutionWithoutUI Specifies that no ui feedback accompany resolution of the bookmark data.available in ios 4.0 and later.declared in nsurl.h.
NSURLBookmarkResolutionWithoutMounting Specifies that no volume should be mounted during resolution of the bookmark data.available in ios 4.0 and later.declared in nsurl.h.
NSURLBookmarkResolutionWithSecurityScope Specifies that the security scope, applied to the bookmark when it was created, should be used during resolution of the bookmark data.available in ios 6.0 and later.declared in nsurl.h.
NSURLKeysOfUnsetValuesKey Key for the resource properties that have not been set after the setresourcevalues:error: method returns an error, returned as an array of of nsstring objects.available in ios 5.0 and later.declared in nsurl.h.
NSURLIsUbiquitousItemKey A boolean nsnumber that contains true if this item is in icloud storage, false if it is a local item.available in ios 5.0 and later.declared in nsurl.h.
NSURLUbiquitousItemHasUnresolvedConflictsKey A boolean nsnumber that contains true if this item has conflicts outstanding, false otherwise.available in ios 5.0 and later.declared in nsurl.h.
NSURLUbiquitousItemIsDownloadedKey A boolean nsnumber that contains true if this item’s data has been downloaded to a ubiquity container, false otherwise.available in ios 5.0 and later.declared in nsurl.h.
NSURLUbiquitousItemIsDownloadingKey A boolean nsnumber that contains true if this item is being downloaded from icloud, false otherwise.available in ios 5.0 and later.declared in nsurl.h.
NSURLUbiquitousItemIsUploadedKey A boolean nsnumber that contains true if this item’s data has been uploaded to icloud storage, false otherwise.available in ios 5.0 and later.declared in nsurl.h.
NSURLUbiquitousItemIsUploadingKey A boolean nsnumber that contains true if this item is being uploaded to icloud, false otherwise.available in ios 5.0 and later.declared in nsurl.h.
NSURLUbiquitousItemPercentDownloadedKey An nsnumber in the range 0–100 that indicates the percentage of the data that has been downloaded.deprecated. instead, use the property key nsmetadataubiquitousitempercentdownloadedkey of the nsmetadataquery class to obtain information on an nsmetadataitem object.available in ios 5.0 and later.deprecated in ios 6.0.declared in nsurl.h.
NSURLUbiquitousItemPercentUploadedKey An nsnumber in the range 0-100 that indicates the percentage of the data that has been uploaded.deprecated. instead, use the property key nsmetadataubiquitousitempercentuploadedkey of the nsmetadataquery class to obtain information on an nsmetadataitem object.available in ios 5.0 and later.deprecated in ios 6.0.declared in nsurl.h.
NSURLProtectionSpaceHTTP The protocol type for http.available in ios 4.0 and later.declared in nsurlprotectionspace.h.
NSURLProtectionSpaceHTTPS The protocol type for https.available in ios 4.0 and later.declared in nsurlprotectionspace.h.
NSURLProtectionSpaceFTP The protocol type for ftp.available in ios 4.0 and later.declared in nsurlprotectionspace.h.
NSURLProtectionSpaceHTTPProxy The proxy type for http proxies.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLProtectionSpaceHTTPSProxy The proxy type for https proxies.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLProtectionSpaceFTPProxy The proxy type for ftp proxies.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLProtectionSpaceSOCKSProxy The proxy type for socks proxies.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodDefault Use the default authentication method for a protocol.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodHTTPBasic Use http basic authentication for this protection space. this is equivalent to nsurlauthenticationmethoddefault for http.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodHTTPDigest Use http digest authentication for this protection space.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodHTMLForm Use html form authentication for this protection space. this authentication method can apply to any protocol.available in ios 2.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodNegotiate Negotiate authentication for this protection space. available in ios 4.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodNTLM Use ntlm authentication for this protection space. available in ios 4.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodClientCertificate Use client certificate authentication for this protection space. this authentication method can apply to any protocol.available in ios 3.0 and later.declared in nsurlprotectionspace.h.
NSURLAuthenticationMethodServerTrust Use server trust authentication for this protection space. this authentication method can apply to any protocol.available in ios 3.0 and later.declared in nsurlprotectionspace.h.
NSURLRequestUseProtocolCachePolicy Specifies that the caching logic defined in the protocol implementation, if any, is used for a particular url load request. this is the default policy for url load requests.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLRequestReloadIgnoringLocalCacheData Specifies that the data for the url load should be loaded from the originating source. no existing cache data should be used to satisfy a url load request.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLRequestReloadIgnoringLocalAndRemoteCacheData Specifies that not only should the local cache data be ignored, but that proxies and other intermediates should be instructed to disregard their caches so far as the protocol allows.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLRequestReloadIgnoringCacheData Replaced by nsurlrequestreloadignoringlocalcachedata.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLRequestReturnCacheDataElseLoad Specifies that the existing cached data should be used to satisfy the request, regardless of its age or expiration date. if there is no existing data in the cache corresponding the request, the data is loaded from the originating source.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLRequestReturnCacheDataDontLoad Specifies that the existing cache data should be used to satisfy a request, regardless of its age or expiration date. if there is no existing data in the cache corresponding to a url load request, no attempt is made to load the data from the originating source, and the load is considered to have failed. this constant specifies a behavior that is similar to an “offline” mode.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLRequestReloadRevalidatingCacheData Specifies that the existing cache data may be used provided the origin source confirms its validity, otherwise the url is loaded from the origin source.available in ios 2.0 and later.declared in nsurlrequest.h.
NSURLNetworkServiceTypeDefault Specifies standard network traffic.available in ios 4.0 and later.declared in nsurlrequest.h.
NSURLNetworkServiceTypeVoIP Specifies that the request is for voip traffic.available in ios 4.0 and later.declared in nsurlrequest.h.
NSURLNetworkServiceTypeVideo Specifies that the request is for video traffic.available in ios 5.0 and later.declared in nsurlrequest.h.
NSURLNetworkServiceTypeBackground Specifies that the request is for background traffic.available in ios 5.0 and later.declared in nsurlrequest.h.
NSURLNetworkServiceTypeVoice Specifies that the request is for voice traffic.available in ios 5.0 and later.declared in nsurlrequest.h.
NSURLResponseUnknownLength Returned when the response length cannot be determined in advance of receiving the data from the server. for example, nsurlresponseunknownlength is returned when the server http response does not include a content-length header.available in ios 2.0 and later.declared in nsurlresponse.h.
NSGlobalDomain The domain consisting of defaults meant to be seen by all applications.available in ios 2.0 and later.declared in nsuserdefaults.h.
NSArgumentDomain The domain consisting of defaults parsed from the application’s arguments. these are one or more pairs of the form -default value included in the command-line invocation of the application. available in ios 2.0 and later.declared in nsuserdefaults.h.
NSRegistrationDomain The domain consisting of a set of temporary defaults whose values can be set by the application to ensure that searches will always be successful.available in ios 2.0 and later.declared in nsuserdefaults.h.
NSNegateBooleanTransformerName This value transformer negates a boolean value, transforming yes to no and no to yes.this transformer is reversible.available in ios 3.0 and later.declared in nsvaluetransformer.h.
NSIsNilTransformerName This value transformer returns yes if the value is nil. this transformer is not reversible.available in ios 3.0 and later.declared in nsvaluetransformer.h.
NSIsNotNilTransformerName This value transformer returns yes if the value is non-nil.this transformer is not reversible.available in ios 3.0 and later.declared in nsvaluetransformer.h.
NSUnarchiveFromDataTransformerName This value transformer returns an object created by attempting to unarchive the data in the nsdata object passed as the value.the reverse transformation returns an nsdata instance created by archiving the value. the archived object must implement the nscoding protocol using sequential archiving in order to be unarchived and archived with this transformer.available in ios 3.0 and later.declared in nsvaluetransformer.h.
NSKeyedUnarchiveFromDataTransformerName This value transformer returns an object created by attempting to unarchive the data in the nsdata object passed as the value. the archived object must be created using keyed archiving in order to be unarchived and archived with this transformer. the reverse transformation returns an nsdata instance created by archiving the value using keyed archiving. the archived object must implement the nscoding protocol using keyed archiving in order to be unarchived and archived with this transformer.available in ios 3.0 and later.declared in nsvaluetransformer.h.
NSXMLParserErrorDomain Indicates an error in xml parsing.used by nserror.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInternalError The parser object encountered an internal error.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserOutOfMemoryError The parser object ran out of memory.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserDocumentStartError The parser object is unable to start parsing.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEmptyDocumentError The document is empty.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserPrematureDocumentEndError The document ended unexpectedly.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidHexCharacterRefError Invalid hexadecimal character reference encountered.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidDecimalCharacterRefError Invalid decimal character reference encountered.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidCharacterRefError Invalid character reference encountered.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidCharacterError Invalid character encountered.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCharacterRefAtEOFError Target of character reference cannot be found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCharacterRefInPrologError Invalid character found in the prolog.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCharacterRefInEpilogError Invalid character found in the epilog.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCharacterRefInDTDError Invalid character encountered in the dtd.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityRefAtEOFError Target of entity reference is not found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityRefInPrologError Invalid entity reference found in the prolog.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityRefInEpilogError Invalid entity reference found in the epilog.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityRefInDTDError Invalid entity reference found in the dtd.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefAtEOFError Target of parsed entity reference is not found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefInPrologError Target of parsed entity reference is not found in prolog.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefInEpilogError Target of parsed entity reference is not found in epilog.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefInInternalSubsetError Target of parsed entity reference is not found in internal subset.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityReferenceWithoutNameError Entity reference is without name.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityReferenceMissingSemiError Entity reference is missing semicolon.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefNoNameError Parsed entity reference is without an entity name.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefMissingSemiError Parsed entity reference is missing semicolon.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserUndeclaredEntityError Entity is not declared.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserUnparsedEntityError Cannot parse entity.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityIsExternalError Cannot parse external entity.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityIsParameterError Entity is a parameter.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserUnknownEncodingError Document encoding is unknown.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEncodingNotSupportedError Document encoding is not supported.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserStringNotStartedError String is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserStringNotClosedError String is not closed.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNamespaceDeclarationError Invalid namespace declaration encountered.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityNotStartedError Entity is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityNotFinishedError Entity is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserLessThanSymbolInAttributeError Angle bracket is used in attribute.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserAttributeNotStartedError Attribute is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserAttributeNotFinishedError Attribute is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserAttributeHasNoValueError Attribute doesn’t contain a value.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserAttributeRedefinedError Attribute is redefined.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserLiteralNotStartedError Literal is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserLiteralNotFinishedError Literal is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCommentNotFinishedError Comment is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserProcessingInstructionNotStartedError Processing instruction is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserProcessingInstructionNotFinishedError Processing instruction is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNotationNotStartedError Notation is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNotationNotFinishedError Notation is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserAttributeListNotStartedError Attribute list is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserAttributeListNotFinishedError Attribute list is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserMixedContentDeclNotStartedError Mixed content declaration is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserMixedContentDeclNotFinishedError Mixed content declaration is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserElementContentDeclNotStartedError Element content declaration is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserElementContentDeclNotFinishedError Element content declaration is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserXMLDeclNotStartedError Xml declaration is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserXMLDeclNotFinishedError Xml declaration is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserConditionalSectionNotStartedError Conditional section is not started.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserConditionalSectionNotFinishedError Conditional section is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserExternalSubsetNotFinishedError External subset is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserDOCTYPEDeclNotFinishedError Document type declaration is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserMisplacedCDATAEndStringError Misplaced cdata end string.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCDATANotFinishedError Cdata block is not finished.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserMisplacedXMLDeclarationError Misplaced xml declaration.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserSpaceRequiredError Space is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserSeparatorRequiredError Separator is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNMTOKENRequiredError Name token is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNAMERequiredError Name is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserPCDATARequiredError Cdata is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserURIRequiredError Uri is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserPublicIdentifierRequiredError Public identifier is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserLTRequiredError Left angle bracket is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserGTRequiredError Right angle bracket is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserLTSlashRequiredError Left angle bracket slash is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEqualExpectedError Equal sign expected.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserTagNameMismatchError Tag name mismatch.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserUnfinishedTagError Unfinished tag found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserStandaloneValueError Standalone value found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidEncodingNameError Invalid encoding name found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserCommentContainsDoubleHyphenError Comment contains double hyphen.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidEncodingError Invalid encoding.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserExternalStandaloneEntityError External standalone entity.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidConditionalSectionError Invalid conditional section.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityValueRequiredError Entity value is required.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNotWellBalancedError Document is not well balanced.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserExtraContentError Error in content found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidCharacterInEntityError Invalid character in entity found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserParsedEntityRefInInternalError Internal error in parsed entity reference found.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityRefLoopError Entity reference loop encountered.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserEntityBoundaryError Entity boundary error.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserInvalidURIError Invalid uri specified.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserURIFragmentError Uri fragment.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserNoDTDError Missing dtd.available in ios 2.0 and later.declared in nsxmlparser.h.
NSXMLParserDelegateAbortedParseError Delegate aborted parse.available in ios 2.0 and later.declared in nsxmlparser.h.
NSRoundPlain Round to the closest possible return value; when caught halfway between two positive numbers, round up; when caught between two negative numbers, round down.available in ios 2.0 and later.declared in nsdecimal.h.
NSRoundDown Round return values down.available in ios 2.0 and later.declared in nsdecimal.h.
NSRoundUp Round return values up.available in ios 2.0 and later.declared in nsdecimal.h.
NSRoundBankers Round to the closest possible return value; when halfway between two possibilities, return the possibility whose last digit is even.in practice, this means that, over the long run, numbers will be rounded up as often as they are rounded down; there will be no systematic bias.available in ios 2.0 and later.declared in nsdecimal.h.
NSCalculationNoError No error occurred.available in ios 2.0 and later.declared in nsdecimal.h.
NSCalculationLossOfPrecision The number can’t be represented in 38 significant digits.available in ios 2.0 and later.declared in nsdecimal.h.
NSCalculationOverflow The number is too large to represent.available in ios 2.0 and later.declared in nsdecimal.h.
NSCalculationUnderflow The number is too small to represent.available in ios 2.0 and later.declared in nsdecimal.h.
NSCalculationDivideByZero The caller tried to divide by 0.available in ios 2.0 and later.declared in nsdecimal.h.
NSUndefinedKeyException Raised when a key value coding operation fails. userinfo keys are described in “nsundefinedkeyexception userinfo keys”available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSTargetObjectUserInfoKey The object on which the key value coding operation failed.
NSUnknownUserInfoKey The key for which the key value coding operation failed.
NSAverageKeyValueOperator The @avg array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSCountKeyValueOperator The @count array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSDistinctUnionOfArraysKeyValueOperator The @distinctunionofarrays array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSDistinctUnionOfObjectsKeyValueOperator The @distinctunionofobjects array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSDistinctUnionOfSetsKeyValueOperator The @distinctunionofsets array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSMaximumKeyValueOperator The @max array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSMinimumKeyValueOperator The @min array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSSumKeyValueOperator The @sum array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSUnionOfArraysKeyValueOperator The @unionofarrays array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSUnionOfObjectsKeyValueOperator The @unionofobjects array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSUnionOfSetsKeyValueOperator The @unionofsets array operator.available in ios 2.0 and later.declared in nskeyvaluecoding.h.
NSKeyValueChangeSetting Indicates that the value of the observed key path was set to a new value. this change can occur when observing an attribute of an object, as well as properties that specify to-one and to-many relationships.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeInsertion Indicates that an object has been inserted into the to-many relationship that is being observed.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeRemoval Indicates that an object has been removed from the to-many relationship that is being observed.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeReplacement Indicates that an object has been replaced in the to-many relationship that is being observed.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueObservingOptionNew Indicates that the change dictionary should provide the new attribute value, if applicable.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueObservingOptionOld Indicates that the change dictionary should contain the old attribute value, if applicable.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueObservingOptionInitial If specified, a notification should be sent to the observer immediately, before the observer registration method even returns. the change dictionary in the notification will always contain an nskeyvaluechangenewkey entry if nskeyvalueobservingoptionnew is also specified but will never contain an nskeyvaluechangeoldkey entry. (in an initial notification the current value of the observed property may be old, but it's new to the observer.) you can use this option instead of explicitly invoking, at the same time, code that is also invoked by the observer's observevalueforkeypath:ofobject:change:context: method. when this option is used withaddobserver:forkeypath:options:context: a notification will be sent for each indexed object to which the observer is being added.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueObservingOptionPrior Whether separate notifications should be sent to the observer before and after each change, instead of a single notification after the change. the change dictionary in a notification sent before a change always contains an nskeyvaluechangenotificationispriorkey entry whose value is [nsnumber numberwithbool:yes], but never contains an nskeyvaluechangenewkey entry. when this option is specified the change dictionary in a notification sent after a change contains the same entries that it would contain if this option were not specified. you can use this option when the observer's own key-value observing-compliance requires it to invoke one of the -willchange... methods for one of its own properties, and the value of that property depends on the value of the observed object's property. (in that situation it's too late to easily invoke -willchange... properly in response to receiving an observevalueforkeypath:ofobject:change:context: message after the change.)available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeKindKey An nsnumber object that contains a value corresponding to one of the “nskeyvaluechange” enums, indicating what sort of change has occurred.a value of nskeyvaluechangesetting indicates that the observed object has received a setvalue:forkey: message, or that the key-value-coding-compliant set method for the key has been invoked, or that one of the willchangevalueforkey: or didchangevalueforkey: methods has otherwise been invoked.a value of nskeyvaluechangeinsertion, nskeyvaluechangeremoval, or nskeyvaluechangereplacement indicates that mutating messages have been sent a key-value observing compliant collection proxy, or that one of the key-value-coding-compliant collection mutation methods for the key has been invoked, or a collection will change or did change method has been otherwise been invoked.you can use nsnumber’s intvalue method to retrieve the integer value of the change kind.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeNewKey If the value of the nskeyvaluechangekindkey entry is nskeyvaluechangesetting, and nskeyvalueobservingoptionnew was specified when the observer was registered, the value of this key is the new value for the attribute. for nskeyvaluechangeinsertion or nskeyvaluechangereplacement, if nskeyvalueobservingoptionnew was specified when the observer was registered, the value for this key is an nsarray instance that contains the objects that have been inserted or replaced other objects, respectively.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeOldKey If the value of the nskeyvaluechangekindkey entry is nskeyvaluechangesetting, and nskeyvalueobservingoptionold was specified when the observer was registered, the value of this key is the value before the attribute was changed.for nskeyvaluechangeremoval or nskeyvaluechangereplacement, if nskeyvalueobservingoptionold was specified when the observer was registered, the value is an nsarray instance that contains the objects that have been removed or have been replaced by other objects, respectively.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeIndexesKey If the value of the nskeyvaluechangekindkey entry is nskeyvaluechangeinsertion, nskeyvaluechangeremoval, or nskeyvaluechangereplacement, the value of this key is an nsindexset object that contains the indexes of the inserted, removed, or replaced objects.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueChangeNotificationIsPriorKey If the option nskeyvalueobservingoptionprior was specified when the observer was registered this notification is sent prior to a change.the change dictionary contains an nskeyvaluechangenotificationispriorkey entry whose value is an nsnumber wrapping yes.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueUnionSetMutation Indicates that objects in the specified set are being added to the receiver. this mutation kind results in a nskeyvaluechangekindkey value of nskeyvaluechangeinsertion.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueMinusSetMutation Indicates that the objects in the specified set are being removed from the receiver. this mutation kind results in a nskeyvaluechangekindkey value of nskeyvaluechangeremoval.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueIntersectSetMutation Indicates that the objects not in the specified set are being removed from the receiver. this mutation kind results in a nskeyvaluechangekindkey value of nskeyvaluechangeremoval.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
NSKeyValueSetSetMutation Indicates that set of objects are replacing the existing objects in the receiver. this mutation kind results in a nskeyvaluechangekindkey value of nskeyvaluechangereplacement.available in ios 2.0 and later.declared in nskeyvalueobserving.h.
AVAudioSessionCategoryAmbient For an app in which sound playback is nonprimary—that is, your app can be used successfully with the sound turned off.this category is also appropriate for “play along” style apps, such as a virtual piano that a user plays over ipod audio. when you use this category, audio from other apps mixes with your audio. your audio is silenced by screen locking and by the silent switch (called the ring/silent switch on iphone).available in ios 3.0 and later.declared in avaudiosession.h.
AVAudioSessionCategorySoloAmbient The default category; used unless you set a category with the setcategory:error: method.when you use this category, audio from other apps is silenced. your audio is silenced by screen locking and by the silent switch (called the ring/silent switch on iphone).available in ios 3.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryPlayback For playing recorded music or other sounds that are central to the successful use of your app.when using this category, your app audio continues with the silent switch set to silent or when the screen locks. (the switch is called the ring/silent switch on iphone.)this category normally prevents audio from other apps from mixing with your app's audio. to allow mixing for this category, use the kaudiosessionproperty_overridecategorymixwithothers property.available in ios 3.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryRecord For recording audio; this category silences playback audio. recording continues with the screen locked.available in ios 3.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryPlayAndRecord Allows recording (input) and playback (output) of audio, such as for a voip (voice over ip) app.your audio continues with the silent switch set to silent and with the screen locked. (the switch is called the ring/silent switch on iphone.)this category is appropriate for simultaneous recording and playback, and also for apps that record and play back but not simultaneously. if you want to ensure that sounds such as messages alerts do not play while your app is recording, use the avaudiosessioncategoryrecord category instead.this category normally prevents audio from other apps from mixing with your app's audio. to allow mixing when using this category, use the kaudiosessionproperty_overridecategorymixwithothers property.available in ios 3.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryAudioProcessing For using an audio hardware codec or signal processor while not playing or recording audio. use this category, for example, when performing offline audio format conversion.this category disables playback (audio output) and disables recording (audio input).audio processing does not normally continue when your app is in the background. however, when your app moves to the background, you can request additional time to complete processing. for more information, see ios app programming guide.available in ios 3.1 and later.declared in avaudiosession.h.
AVAudioSessionCategoryMultiRoute Allows you to output distinct streams of audio data to different output devices at the same time. for example, you would use this category to route audio to both a usb device and a set of headphones. use of this category requires a more detailed knowledge of, and interaction with, the capabilities of the available audio routes. this category may be used for input, output, or both.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryOptionMixWithOthers Allow audio in this session to be mixed with audio from other active sessions. this option is only valid if the session category is avaudiosessioncategoryplayandrecord or avaudiosessioncategoryplayback. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryOptionDuckOthers Allow audio in this session to duck under the audio for other active sessions. this option is only valid if the session category is avaudiosessioncategoryplayandrecord.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryOptionAllowBluetooth Allow audio in this session to be received from or sent to a bluetooth device. this option is only valid if the session category is avaudiosessioncategoryplayandrecord or avaudiosessioncategoryrecord. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionCategoryOptionDefaultToSpeaker Allow audio in this session to route to the built-in speaker by default. this option is only valid if the session category is avaudiosessioncategoryplayandrecord.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionModeDefault The default mode; used unless you set a mode with the setmode:error: method.when this mode is in use, audio session behavior matches that of ios versions prior to ios 5.0. you can use this mode with every audio session category. on devices more than one built-in microphone, the primary microphone is used.available in ios 5.0 and later.declared in avaudiosession.h.
AVAudioSessionModeVoiceChat Specify this mode if your app is performing two-way voice communication, such as using voice over internet protocol (voip).when this mode is in use, the device’s tonal equalization is optimized for voice. for use with the avaudiosessioncategoryplayandrecord audio session category. on devices with more than one built-in microphone, the primary microphone is used.using this mode has the side effect of setting the kaudiosessionproperty_overridecategoryenablebluetoothinput category override to true.available in ios 5.0 and later.declared in avaudiosession.h.
AVAudioSessionModeGameChat Do not set this mode directly. this mode is set by game kit on behalf of an application that uses a gkvoicechat object. this mode is valid only with the avaudiosessioncategoryplayandrecord category. if you need similar behavior and are not using a gkvoicechat object, use avaudiosessionmodevoicechat instead. available in ios 5.0 and later.declared in avaudiosession.h.
AVAudioSessionModeVideoRecording Specify this mode if your app is recording a movie.for use with the avaudiosessioncategoryrecord audio session category. also works with the avaudiosessioncategoryplayandrecord category. on devices with more than one built-in microphone, the microphone closest to the video camera is used.using this mode may result in the system providing appropriate audio signal processing.available in ios 5.0 and later.declared in avaudiosession.h.
AVAudioSessionModeMeasurement Specify this mode if your app is performing measurement of incoming audio.when this mode is in use, the device does not perform automatic gain adjustment on incoming audio. for use with the avaudiosessioncategoryrecord or avaudiosessioncategoryplayandrecord audio session categories. on devices with more than one built-in microphone, the primary microphone is used.available in ios 5.0 and later.declared in avaudiosession.h.
AVAudioSessionModeMoviePlayback Specify this mode if your app is playing back movie content.when this mode is in use, the device engages any appropriate signal processing hardware to improve audio content played over the built-in speaker. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionInterruptionOptionShouldResume Indicates that the audio session is active and immediately ready to be used. your app can resume the audio operation that was interrupted.look for this flag in the flags parameter when your audio session delegate’s endinterruptionwithflags: method is invoked.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionSetActiveOptionNotifyOthersOnDeactivation When passed in the flags parameter of the setactive:withflags:error: instance method, indicates that when your audio session deactivates, other audio sessions that had been interrupted by your session can return to their active state.this flag is used only when deactivating your audio session; that is, when you pass a value of no in the beactive parameter of the setactive:withflags:error: instance method.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortOverrideNone Do not override the output audio port. use this option to route audio to the intended outputs.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortOverrideSpeaker Override the current outputs and route audio to the built-in speaker. use this override only in conjunction with the avaudiosessioncategoryplayandrecord category. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonUnknown The reason for the change is unknown.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonNewDeviceAvailable A preferred new audio output path is now available.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonOldDeviceUnavailable The previous audio output path is no longer available. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonCategoryChange The category of the session object changed.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonOverride The output route was overridden by the app. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonWakeFromSleep The route changed when the device woke up from sleep. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonNoSuitableRouteForCategory The route changed because no suitable route is now available for the specified category. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionInterruptionTypeBegan The system interrupted the audio session.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionInterruptionTypeEnded The interruption ended. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionInterruptionTypeKey The value for this key is an nsnumber object containing an unsigned integer that identifies the type of interruption. for a list of possible values, see “avaudiosessioninterruptiontype”. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionInterruptionOptionKey The value for this key is an nsnumber object containing an unsigned integer that identifies any options associated with the interruption. for a list of possible flags, see “avaudiosessioninterruptionoptions”. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangeReasonKey The value for this key is an nsnumber object containing an unsigned integer that identifies the reason why the route changed. for a list of possible values, see “avaudiosessionroutechangereason”. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionRouteChangePreviousRouteKey The value for this key is an avaudiosessionroutedescription object with the previous route information. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionInterruptionFlags_ShouldResume Indicates that your audio session is active and immediately ready to be used. your app can resume the audio operation that was interrupted. (deprecated. use avaudiosessioninterruptionoptionshouldresume instead.)look for this flag in the flags parameter when your audio session delegate’s endinterruptionwithflags: method is invoked.available in ios 4.0 and later.declared in avaudiosession.h.
AVAudioSessionSetActiveFlags_NotifyOthersOnDeactivation When passed in the flags parameter of the setactive:withflags:error: instance method, indicates that when your audio session deactivates, other audio sessions that had been interrupted by your session can return to their active state. (deprecated. use avaudiosessionsetactiveoptionnotifyothersondeactivation instead.)this flag is used only when deactivating your audio session; that is, when you pass a value of no in the beactive parameter of the setactive:withflags:error: instance method.available in ios 4.0 and later.declared in avaudiosession.h.
NSUndefinedEntityMappingType Specifies that the developer handles destination instance creation.available in ios 3.0 and later.declared in nsentitymapping.h.
NSCustomEntityMappingType Specifies a custom mapping.available in ios 3.0 and later.declared in nsentitymapping.h.
NSAddEntityMappingType Specifies that this is a new entity in the destination model.instances of the entity only exist in the destination.available in ios 3.0 and later.declared in nsentitymapping.h.
NSRemoveEntityMappingType Specifies that this entity is not present in the destination model.instances of the entity only exist in the source—source instances are not mapped to destination.available in ios 3.0 and later.declared in nsentitymapping.h.
NSCopyEntityMappingType Specifies that source instances are migrated as-is.available in ios 3.0 and later.declared in nsentitymapping.h.
NSTransformEntityMappingType Specifies that entity exists in source and destination and is mapped.available in ios 3.0 and later.declared in nsentitymapping.h.
NSMigrationManagerKey Key for the migration manager.to access this key in a custom value expression string in the xcode mapping model editor use $manager.available in ios 3.0 and later.declared in nsentitymigrationpolicy.h.
NSMigrationSourceObjectKey Key for the source object.to access this key in a custom value expression string in the xcode mapping model editor use $source.available in ios 3.0 and later.declared in nsentitymigrationpolicy.h.
NSMigrationDestinationObjectKey Key for the destination object.to access this key in a custom value expression string in the xcode mapping model editor use $destination.available in ios 3.0 and later.declared in nsentitymigrationpolicy.h.
NSMigrationEntityMappingKey Key for the entity mapping object.to access this key in a custom value expression string in the xcode mapping model editor use $entitymapping.available in ios 3.0 and later.declared in nsentitymigrationpolicy.h.
NSMigrationPropertyMappingKey Key for the property mapping object.to access this key in a custom value expression string in the xcode mapping model editor use $propertymapping.available in ios 3.0 and later.declared in nsentitymigrationpolicy.h.
NSMigrationEntityPolicyKey Key for the entity migration policy object.to access this key in a custom value expression string in the xcode mapping model editor use $entitypolicy.available in ios 3.0 and later.declared in nsentitymigrationpolicy.h.
NSFetchRequestExpressionType Specifies the fetch request expression type.available in ios 3.0 and later.declared in nsfetchrequestexpression.h.
NSHashTableStrongMemory Equal to nspointerfunctionsstrongmemory.available in ios 6.0 and later.declared in nshashtable.h.
NSHashTableCopyIn Equal to nspointerfunctionscopyin.available in ios 6.0 and later.declared in nshashtable.h.
NSHashTableObjectPointerPersonality Equal to nspointerfunctionsobjectpointerpersonality.available in ios 6.0 and later.declared in nshashtable.h.
NSHashTableWeakMemory Equal to nspointerfunctionsweakmemory. uses weak read and write barriers appropriate for arc or gc. using nspointerfunctionsweakmemory object references will turn to null on last release.available in ios 6.0 and later.declared in nshashtable.h.
NSInvocationOperationVoidResultException The name of the exception raised if the result method is called for an invocation method with a void return type. available in ios 2.0 and later.declared in nsoperation.h.
NSInvocationOperationCancelledException The name of the exception raised if the result method is called after the operation was cancelled. available in ios 2.0 and later.declared in nsoperation.h.
NSLinguisticTaggerOmitWords Omit tokens of type nslinguistictagword (items considered to be words).available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTaggerOmitPunctuation Omit tokens of type nslinguistictagpunctuation (all punctuation).available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTaggerOmitWhitespace Omit tokens of type nslinguistictagwhitespace (whitespace of all sorts).available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTaggerOmitOther Omit tokens of type nslinguistictagother (non-linguistic items such as symbols).available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTaggerJoinNames Typically, multiple-word names will be returned as multiple tokens, following the standard tokenization practice of the tagger. if this option is set, then multiple-word names will be joined together and returned as a single token.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeTokenType This tag scheme classifies tokens according to their broad type: word, punctuation, whitespace, etc. the possible tags are: nslinguistictagword, nslinguistictagpunctuation, nslinguistictagwhitespace, or nslinguistictagother. for this scheme a client may use pointer equality to compare the values with the tag constants.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeLexicalClass This tag scheme classifies tokens according to class: part of speech for words, type of punctuation or whitespace, etc. the value will be one of the constants specified in “nslinguistictagschemelexicalclass.” for this scheme a client may use pointer equality to compare the values with the tag constants.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeNameType This tag scheme classifies tokens as to whether they are part of named entities of various types or not. the possible tags are: nslinguistictagpersonalname, nslinguistictagplacename, or nslinguistictagorganizationname. for this scheme a client may use pointer equality to compare the values with the tag constants.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeNameTypeOrLexicalClass This tag scheme follows nslinguistictagschemenametype for names, nslinguistictagschemelexicalclass for all other tokens. the possible tags are those specified in “nslinguistictagschemelexicalclass” or “nslinguistictagschemenametype.” for this scheme a client may use pointer equality to compare the values with the tag constants.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeLemma This tag scheme supplies a stem forms of the words, if known.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeLanguage This tag scheme tags tokens according to their script. the tag values will be standard language abbreviations such as “en”, “fr”, “de”, etc., as used with the nsorthography class. note that the tagger generally attempts to determine the language of text at the level of an entire sentence or paragraph, rather than word by word.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSchemeScript This tag scheme tags tokens according to their script. the tag values will be standard script abbreviations such as “latn”, “cyrl”, “jpan”, “hans”, “hant”, etc.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagWord The token indicates a word.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagPunctuation The token indicates punctuation.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagWhitespace The token indicates white space of any sort.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOther The token indicates a token other than those currently defined.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagNoun The token is a noun.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagVerb This token is a verb.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagAdjective This token is an adjectiveavailable in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagAdverb This token is an adverb.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagPronoun This token is a pronoun.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagDeterminer This token is a determiner.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagParticle This token is a particle.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagPreposition This token is a preposition.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagNumber This token is a number.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagConjunction This token is a conjunction.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagInterjection This token is an interjection.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagClassifier This token is a classifier.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagIdiom This token is an idiom.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOtherWord This token is some other word.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagSentenceTerminator This token is a sentence terminator.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOpenQuote This token is an open quote.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagCloseQuote This token is a close quote.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOpenParenthesis This token is an open parenthesis.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagCloseParenthesis This token is a close parenthesis.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagWordJoiner This token is a word joiner.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagDash This token is a dash.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOtherPunctuation This token is punctuation not recognized as another token type.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagParagraphBreak This token is a paragraph break.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOtherWhitespace This token is whitespace.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagPersonalName This token is a personal name.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagPlaceName This token is a place name.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSLinguisticTagOrganizationName This token is an organization name.available in ios 5.0 and later.declared in nslinguistictagger.h.
NSMapTableStrongMemory Specifies a strong reference from the map table to its contents.equal to nspointerfunctionsstrongmemory.available in ios 6.0 and later.declared in nsmaptable.h.
NSMapTableCopyIn Use the memory acquire function to allocate and copy items on input (see acquirefunction [nspointerfunctions]).equal to nspointerfunctionscopyin.available in ios 6.0 and later.declared in nsmaptable.h.
NSMapTableObjectPointerPersonality Use shifted pointer hash and direct equality, object description.equal to nspointerfunctionsobjectpointerpersonality.available in ios 6.0 and later.declared in nsmaptable.h.
NSMapTableWeakMemory Uses weak read and write barriers appropriate for arc or gc. using nspointerfunctionsweakmemory object references will turn to null on last release. equal to nsmaptablezeroingweakmemory.available in ios 6.0 and later.declared in nsmaptable.h.
NSOperationQueuePriorityVeryLow Operations receive very low priority for execution. available in ios 2.0 and later.declared in nsoperation.h.
NSOperationQueuePriorityLow Operations receive low priority for execution.available in ios 2.0 and later.declared in nsoperation.h.
NSOperationQueuePriorityNormal Operations receive the normal priority for execution.available in ios 2.0 and later.declared in nsoperation.h.
NSOperationQueuePriorityHigh Operations receive high priority for execution.available in ios 2.0 and later.declared in nsoperation.h.
NSOperationQueuePriorityVeryHigh Operations receive very high priority for execution.available in ios 2.0 and later.declared in nsoperation.h.
NSOperationQueueDefaultMaxConcurrentOperationCount The default maximum number of operations is determined dynamically by the nsoperationqueue object based on current system conditions. available in ios 2.0 and later.declared in nsoperation.h.
AVAudioSessionPortBluetoothHFP Specifies input or output on a bluetooth hands-free profile device.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortUSBAudio Specifies input or output on a usb device.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortLineIn Specifies line-level input from the dock connector.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortBuiltInMic Specifies the built-in microphone on a device.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortHeadsetMic Specifies a microphone that is built-in to a wired headset. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortLineOut Specifies line-level output to the dock connector.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortHeadphones Specifies output to a wired headset. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortBluetoothA2DP Specifies output to a bluetooth a2dp device.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortBuiltInReceiver Specifies output to the speaker that you hold to your ear. typically, this speaker is available only on iphone devices.available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortBuiltInSpeaker Specifies output to the device’s built-in speaker. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortHDMI Specifies output to a device via the high-definition multimedia interface (hdmi) specification. available in ios 6.0 and later.declared in avaudiosession.h.
AVAudioSessionPortAirPlay Specifies output to a remote device over airplay. available in ios 6.0 and later.declared in avaudiosession.h.
NSFetchedResultsChangeInsert Specifies that an object was inserted.
NSFetchedResultsChangeDelete Specifies that an object was deleted.
NSFetchedResultsChangeMove Specifies that an object was moved.
NSFetchedResultsChangeUpdate Specifies that an object was changed.
NSErrorMergePolicy This policy causes a save to fail if there are any merge conflicts.this is the default policy for all managed object contexts.in the case of failure, the save method returns with an error with a userinfo dictionary that contains the object ids of the objects that had conflicts (nsinsertedobjectskey, nsupdatedobjectskey).available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSMergeByPropertyStoreTrumpMergePolicy This policy merges conflicts between the persistent store’s version of the object and the current in-memory version, giving priority to external changes. the merge occurs by individual property. for properties that have been changed in both the external source and in memory, the external changes trump the in-memory ones.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSMergeByPropertyObjectTrumpMergePolicy This policy merges conflicts between the persistent store’s version of the object and the current in-memory version, giving priority to in-memory changes. the merge occurs by individual property. for properties that have been changed in both the external source and in memory, the in-memory changes trump the external ones.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSOverwriteMergePolicy This policy overwrites state in the persistent store for the changed objects in conflict.changed objects’ current state is forced upon the persistent store.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSRollbackMergePolicy This policy discards in-memory state changes for objects in conflict.the persistent store’s version of the objects’ state is used.available in ios 3.0 and later.declared in nsmanagedobjectcontext.h.
NSErrorMergePolicyType Specifies a policy that causes a save to fail if there are any merge conflicts.available in ios 5.0 and later.declared in nsmergepolicy.h.
NSMergeByPropertyStoreTrumpMergePolicyType Specifies a policy that merges conflicts between the persistent store’s version of the object and the current in-memory version, giving priority to external changes. available in ios 5.0 and later.declared in nsmergepolicy.h.
NSMergeByPropertyObjectTrumpMergePolicyType Specifies a policy that merges conflicts between the persistent store’s version of the object and the current in-memory version, giving priority to in-memory changes.available in ios 5.0 and later.declared in nsmergepolicy.h.
NSOverwriteMergePolicyType Specifies a policy that overwrites state in the persistent store for the changed objects in conflict.available in ios 5.0 and later.declared in nsmergepolicy.h.
NSRollbackMergePolicyType Specifies a policy that discards in-memory state changes for objects in conflict.available in ios 5.0 and later.declared in nsmergepolicy.h.
NSFetchRequestType Specifies that the request returns managed objects.available in ios 5.0 and later.declared in nspersistentstorerequest.h.
NSSaveRequestType Specifies that the request.available in ios 5.0 and later.declared in nspersistentstorerequest.h.
AVAssetReaderStatusUnknown Indicates that startreading has not yet been invoked.available in ios 4.1 and later.declared in avassetreader.h.
AVAssetReaderStatusReading Indicates that the reader is ready to provide more sample buffers to its outputs.available in ios 4.1 and later.declared in avassetreader.h.
AVAssetReaderStatusCompleted Indicates that the reader has provided all available sample buffers to all of its outputs.available in ios 4.1 and later.declared in avassetreader.h.
AVAssetReaderStatusFailed Indicates that reading failed.available in ios 4.1 and later.declared in avassetreader.h.
AVAssetReaderStatusCancelled Indicates that reading was cancelled using cancelreading.available in ios 4.1 and later.declared in avassetreader.h.
AVCaptureVideoOrientationPortrait Indicates that the video input is oriented vertically, with the device’s home button on the bottom.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureVideoOrientationPortraitUpsideDown Indicates that the video input is oriented vertically, with the device’s home button on the top.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureVideoOrientationLandscapeRight Indicates that the video input is oriented vertically, with the device’s home button on the left.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureVideoOrientationLandscapeLeft Indicates that the video input is oriented vertically, with the device’s home button on the right.available in ios 4.0 and later.declared in avcapturesession.h.
AVVideoFieldModeBoth Indicates that both top and bottom video fields in interlaced content should be passed through.available in ios 6.0 and later.declared in avcapturesession.h.
AVVideoFieldModeTopOnly indicates that only the top video field in interlaced content should be passed through.available in ios 6.0 and later.declared in avcapturesession.h.
AVVideoFieldModeBottomOnly indicates that the bottom video field only in interlaced content should be passed through.available in ios 6.0 and later.declared in avcapturesession.h.
AVVideoFieldModeDeinterlace indicates that top and bottom video fields in interlaced content should be deinterlaced.available in ios 6.0 and later.declared in avcapturesession.h.
AVCaptureDevicePositionUnspecified The capture device’s position relative to the system hardware is unspecified.available in ios 6.0 and later.declared in avcapturedevice.h.
AVCaptureDevicePositionBack The capture device is on the back of the unit.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureDevicePositionFront The capture device is on the front of the unit.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureFlashModeOff The capture device flash is always off.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureFlashModeOn The capture device flash is always on.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureFlashModeAuto The capture device continuously monitors light levels and uses the flash when necessary.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureTorchModeOff The capture device torch is always off.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureTorchModeOn The capture device torch is always on.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureTorchModeAuto The capture device continuously monitors light levels and uses the torch when necessary.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureMaxAvailableTorchLevel This constant always represents the maximum available torch level, independent of the actual maximum value currently supported by the device. thus, pass this constant to the settorchmodeonwithlevel:error: in situations where you want to specify the maximum torch level without having to worry about whether the device is overheating and might not accept a value of 1.0 as the maximum.available in ios 6.0 and later.declared in avcapturedevice.h.
AVCaptureFocusModeLocked The focus is locked.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureFocusModeAutoFocus The capture device performs an autofocus operation now.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureFocusModeContinuousAutoFocus The capture device continuously monitors focus and auto focuses when necessary.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureExposureModeLocked The exposure setting is locked.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureExposureModeAutoExpose The device performs an auto-expose operation now.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureExposureModeContinuousAutoExposure The device continuously monitors exposure levels and auto exposes when necessary.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureWhiteBalanceModeLocked The white balance setting is locked.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureWhiteBalanceModeAutoWhiteBalance The device performs an auto white balance operation now.available in ios 4.0 and later.declared in avcapturedevice.h.
AVCaptureWhiteBalanceModeContinuousAutoWhiteBalance The device continuously monitors white balance and adjusts when necessary.available in ios 4.0 and later.declared in avcapturedevice.h.
CIDetectorTypeFace A detector that searches for faces in a photograph.available in ios 5.0 and later.declared in cidetector.h.
CIDetectorAccuracy A key used to specify the desired accuracy for the detector.the value associated with the key should be one of the values found in “detector accuracy options”.available in ios 5.0 and later.declared in cidetector.h.
CIDetectorTracking A key used to enable or disable face tracking for the detector. use this option when you want to track faces across frames in a video. available in ios 6.0 and later.declared in cidetector.h.
CIDetectorMinFeatureSize A key used to specify the minimum size that the detector will recognize as a feature. the value for this key is an nsnumber object ranging from 0.0 through 1.0 that represents a fraction of the minor dimension of the image.available in ios 6.0 and later.declared in cidetector.h.
CIDetectorAccuracyLow Indicates that the detector should choose techniques that are lower in accuracy, but can be processed more quickly.available in ios 5.0 and later.declared in cidetector.h.
CIDetectorAccuracyHigh Indicates that the detector should choose techniques that are higher in accuracy, even if it requires more processing time.available in ios 5.0 and later.declared in cidetector.h.
CIDetectorImageOrientation A key used to specify the display orientation of the image whose features you want to detect. this key is an nsnumber object with the same value as defined by the tiff and exif specifications; values can range from 1 through 8. the value specifies where the origin (0,0) of the image is located. if not present, the default value is 1, which means the origin of the image is top, left. for details on the image origin specified by each value, see kcgimagepropertyorientation.available in ios 5.0 and later.declared in cidetector.h.
CIFeatureTypeFace The discovered feature is a person’s face.available in ios 5.0 and later.declared in cifeature.h.
CLActivityTypeOther The location manager is being used for an unknown activity.available in ios 6.0 and later.declared in cllocationmanager.h.
CLActivityTypeAutomotiveNavigation The location manager is being used specifically during vehicular navigation to track location changes to the automobile. this activity might cause location updates to be paused only when the vehicle does not move for an extended period of time.available in ios 6.0 and later.declared in cllocationmanager.h.
CLActivityTypeFitness The location manager is being used to track any pedestrian-related activity. this activity might cause location updates to be paused only when the user does not move a significant distance over a period of time.available in ios 6.0 and later.declared in cllocationmanager.h.
CLActivityTypeOtherNavigation The location manager is being used to track movements for other types of vehicular navigation that are not automobile related. for example, you would use this to track navigation by boat, train, or plane. do not use this type for pedestrian navigation tracking. this activity might cause location updates to be paused only when the vehicle does not move a significant distance over a period of time.available in ios 6.0 and later.declared in cllocationmanager.h.
CMErrorDomain Identifies the domain of nserror objects returned from core motion.available in ios 4.0 and later.declared in cmerrordomain.h.
CMErrorNULL No error.available in ios 4.0 and later.declared in cmerror.h.
CMErrorDeviceRequiresMovement The device must move for a sampling of motion data to occur.available in ios 5.0 and later.declared in cmerror.h.
CMErrorTrueNorthNotAvailable True north is not available on this device. this usually indicates that the device’s location is not yet available.available in ios 5.0 and later.declared in cmerror.h.
EKCalendarEventAvailabilityNone The calendar does not support event availability settings.available in ios 4.0 and later.declared in ektypes.h.
EKCalendarEventAvailabilityBusy The calendar supports the busy event availability setting.available in ios 4.0 and later.declared in ektypes.h.
EKCalendarEventAvailabilityFree The calendar supports the free event availability setting.available in ios 4.0 and later.declared in ektypes.h.
EKCalendarEventAvailabilityTentative The calendar supports the tentative event availability setting.available in ios 4.0 and later.declared in ektypes.h.
EKCalendarEventAvailabilityUnavailable The calendar supports the unavailable event availability setting.available in ios 4.0 and later.declared in ektypes.h.
AVCaptureSessionErrorKey Key to retrieve the error object from the user info dictionary of an avcapturesessionruntimeerrornotification.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPresetPhoto Specifies capture settings suitable for high resolution photo quality output.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPresetHigh Specifies capture settings suitable for high quality video and audio output.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPresetMedium Specifies capture settings suitable for output video and audio bitrates suitable for sharing over wifi.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPresetLow Specifies capture settings suitable for output video and audio bitrates suitable for sharing over 3g.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPreset352x288 Specifies capture settings suitable for cif quality (352x288 pixel) video output.available in ios 5.0 and later.declared in avcapturesession.h.
AVCaptureSessionPreset640x480 Specifies capture settings suitable for vga quality (640x480 pixel) video output.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPreset1280x720 Specifies capture settings suitable for 720p quality (1280x720 pixel) video output.available in ios 4.0 and later.declared in avcapturesession.h.
AVCaptureSessionPreset1920x1080 Specifies capture settings suitable for 1080p quality (1920x1080 pixel) video output.available in ios 5.0 and later.declared in avcapturesession.h.
AVCaptureSessionPresetiFrame960x540 Specifies capture settings to achieve 960x540 quality iframe h.264 video at about 30 mbits/sec with aac audio.quicktime movies captured in iframe format are optimal for editing applications.available in ios 5.0 and later.declared in avcapturesession.h.
AVCaptureSessionPresetiFrame1280x720 Specifies capture settings to achieve 1280x720 quality iframe h.264 video at about 40 mbits/sec with aac audio.quicktime movies captured in iframe format are optimal for editing applications.available in ios 5.0 and later.declared in avcapturesession.h.
EKSunday The value for sunday.available in ios 4.0 and later.declared in ektypes.h.
EKMonday The value for monday.available in ios 4.0 and later.declared in ektypes.h.
EKTuesday The value for tuesday.available in ios 4.0 and later.declared in ektypes.h.
EKWednesday The value for wednesday.available in ios 4.0 and later.declared in ektypes.h.
EKThursday The value for thursday.available in ios 4.0 and later.declared in ektypes.h.
EKFriday The value for friday.available in ios 4.0 and later.declared in ektypes.h.
EKSaturday The value for saturday.available in ios 4.0 and later.declared in ektypes.h.
NSByteCountFormatterUseDefault This causes default units appropriate for the platform to be used. this is the default.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseBytes Displays bytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseKB Displays kilobytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseMB Displays megabytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseGB Displays gigabytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseTB Displays terabytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUsePB Displays petabyte in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseEB Displays exabytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseZB Displays zettabytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseYBOrHigher Displays yottabytes in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterUseAll Can use any unit in the formatter content.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterCountStyleFile Specifies display of file byte counts. the actual behavior for this is platform-specific; on os x 10.8, this uses the binary style, but that may change over time.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterCountStyleMemory Specifies display of memory byte counts. the actual behavior for this is platform-specific; on os x 10.8, this uses the binary style, but that may change over time.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterCountStyleDecimal Causes 1000 bytes to be shown as 1 kb. it is better to use nsbytecountformattercountstylefile or nsbytecountformattercountstylememory in most cases.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSByteCountFormatterCountStyleBinary Causes 1024 bytes to be shown as 1 kb. it is better to use nsbytecountformattercountstylefile or nsbytecountformattercountstylememory in most cases.available in ios 6.0 and later.declared in nsbytecountformatter.h.
NSFileCoordinatorReadingWithoutChanges Specify this constant if your code does not need other objects to save changes first. if you do not specify this constant, the savepresenteditemchangeswithcompletionhandler: method of relevant file presenters is called before your code reads the item.available in ios 5.0 and later.declared in nsfilecoordinator.h.
NSFileCoordinatorReadingResolvesSymbolicLink Specify this constant if you want an item that might be a symbolic link to resolve to the file pointed to by that link (instead of to the link itself). this option applies to the url passed to the block that handles the actual reading of the item. available in ios 5.0 and later.declared in nsfilecoordinator.h.
NSFileCoordinatorWritingForDeleting When this constant is specified, the file coordinator calls the accommodatepresenteditemdeletionwithcompletionhandler: method of relevant file presenters to give them a chance to make adjustments before the item is deleted.available in ios 5.0 and later.declared in nsfilecoordinator.h.
NSFileCoordinatorWritingForReplacing Specifies whether the act of writing to the file involves actually replacing the file with a different file (or directory). if the current file coordinator is waiting for another object to move or rename the file, this option treats the operation as the creation of a new file (instead of as the replacement of the old file); otherwise, this constant causes the same behavior as the nsfilecoordinatorwritingfordeleting constant. use this option when the moving or creation of an item would cause the replacement of any existing item. do not use it when simply updating the contents of the existing file. available in ios 5.0 and later.declared in nsfilecoordinator.h.
NSFileCoordinatorWritingForMoving When specified for a directory item, the file coordinator waits for already running read and write operations of the directory’s contents, that were themselves initiated through a file coordinator, to finish before moving the directory. queued, but not executing, read and write operations on the directory’s contents wait until the move operation finishes.this option has no effect on files. available in ios 5.0 and later.declared in nsfilecoordinator.h.
NSFileCoordinatorWritingForMerging When this constant is specified, the file coordinator calls the savepresenteditemchangeswithcompletionhandler: method of relevant file presenters to give them a chance to save their changes before your code makes its changes.available in ios 5.0 and later.declared in nsfilecoordinator.h.
NSFileVersionAddingByMoving When adding a file, you can specify this option if you want to create the version by moving the source file to the specified location.available in ios 5.0 and later.declared in nsfileversion.h.
NSFileVersionReplacingByMoving When replacing a file, move the old version of the file out of the version store instead of copying the new contents into the file’s version. you should use this option in conjunction with a file coordinator to make sure the operation is coordinated with other clients of the file. available in ios 5.0 and later.declared in nsfileversion.h.
NSJSONReadingMutableContainers Specifies that arrays and dictionaries are created as mutable objects.available in ios 5.0 and later.declared in nsjsonserialization.h.
NSJSONReadingMutableLeaves Specifies that leaf strings in the json object graph are created as instances of nsmutablestring.available in ios 5.0 and later.declared in nsjsonserialization.h.
NSJSONReadingAllowFragments Specifies that the parser should allow top-level objects that are not an instance of nsarray or nsdictionary. available in ios 5.0 and later.declared in nsjsonserialization.h.
NSJSONWritingPrettyPrinted Specifies that the json data should be generated with whitespace designed to make the output more readable. if this option is not set, the most compact possible json representation is generated.available in ios 5.0 and later.declared in nsjsonserialization.h.
NSRegularExpressionCaseInsensitive Match letters in the pattern independent of case.available in ios 4.0 and later.declared in nsregularexpression.h.
NSRegularExpressionAllowCommentsAndWhitespace Ignore whitespace and #-prefixed comments in the pattern.available in ios 4.0 and later.declared in nsregularexpression.h.
NSRegularExpressionIgnoreMetacharacters Treat the entire pattern as a literal string.available in ios 4.0 and later.declared in nsregularexpression.h.
NSRegularExpressionDotMatchesLineSeparators Allow . to match any character, including line separators.available in ios 4.0 and later.declared in nsregularexpression.h.
NSRegularExpressionAnchorsMatchLines Allow ^ and $ to match the start and end of lines.available in ios 4.0 and later.declared in nsregularexpression.h.
NSRegularExpressionUseUnixLineSeparators Treat only n as a line separator (otherwise, all standard line separators are used).available in ios 4.0 and later.declared in nsregularexpression.h.
NSRegularExpressionUseUnicodeWordBoundaries Use unicode tr#29 to specify word boundaries (otherwise, traditional regular expression word boundaries are used).available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingProgress Set when the block is called to report progress during a long-running match operation. available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingCompleted Set when the block is called after matching has completed. available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingHitEnd Set when the current match operation reached the end of the search range.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingRequiredEnd Set when the current match depended on the location of the end of the search range.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingInternalError Set when matching failed due to an internal error.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingReportProgress Call the block periodically during long-running match operations. this option has no effect for methods other than enumeratematchesinstring:options:range:usingblock:. see enumeratematchesinstring:options:range:usingblock: for a description of the constant in context.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingReportCompletion Call the block once after the completion of any matching. this option has no effect for methods other than enumeratematchesinstring:options:range:usingblock:. see enumeratematchesinstring:options:range:usingblock: for a description of the constant in context.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingAnchored Specifies that matches are limited to those at the start of the search range. see enumeratematchesinstring:options:range:usingblock: for a description of the constant in context.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingWithTransparentBounds Specifies that matching may examine parts of the string beyond the bounds of the search range, for purposes such as word boundary detection, lookahead, etc. this constant has no effect if the search range contains the entire string. see enumeratematchesinstring:options:range:usingblock: for a description of the constant in context.available in ios 4.0 and later.declared in nsregularexpression.h.
NSMatchingWithoutAnchoringBounds Specifies that ^ and $ will not automatically match the beginning and end of the search range, but will still match the beginning and end of the entire string. this constant has no effect if the search range contains the entire string. see enumeratematchesinstring:options:range:usingblock: for a description of the constant in context.available in ios 4.0 and later.declared in nsregularexpression.h.
NSUbiquitousKeyValueStoreChangeReasonKey The value of this key indicates the reason the key-value store changed, as described in “change reason values .”an nsnumber object with an integer value.available in ios 5.0 and later.declared in nsubiquitouskeyvaluestore.h.
NSUbiquitousKeyValueStoreChangedKeysKey The value of this key is an array of nsstring objects, where each is the name of a key that changed in the key-value store.available in ios 5.0 and later.declared in nsubiquitouskeyvaluestore.h.
NSUbiquitousKeyValueStoreServerChange A value changed in icloud. this occurs when another device, running another instance of your app and attached to the same icloud account, uploads a new value.available in ios 5.0 and later.declared in nsubiquitouskeyvaluestore.h.
NSUbiquitousKeyValueStoreInitialSyncChange Your attempt to write to key-value storage was discarded because an initial download from icloud has not yet happened. that is, before you can first write key-value data, the system must ensure that your app’s local, on-disk cache matches the truth in icloud.initial downloads happen the first time a device is connected to an icloud account, and when a user switches their primary icloud account.available in ios 5.0 and later.declared in nsubiquitouskeyvaluestore.h.
NSUbiquitousKeyValueStoreQuotaViolationChange Your app’s key-value store has exceeded its space quota on the icloud server.available in ios 5.0 and later.declared in nsubiquitouskeyvaluestore.h.
NSUbiquitousKeyValueStoreAccountChange The user has changed the primary icloud account. the keys and values in the local key-value store have been replaced with those from the new account, regardless of the relative timestamps.available in ios 6.0 and later.declared in nsubiquitouskeyvaluestore.h.
GKChallengeStateInvalid An error occurred. the state of this challenge is not valid.available in ios 6.0 and later.declared in gkchallenge.h.
GKChallengeStatePending The challenge has been issued, but is not yet completed nor declined.available in ios 6.0 and later.declared in gkchallenge.h.
GKChallengeStateCompleted The receiving player successfully completed the challenge.available in ios 6.0 and later.declared in gkchallenge.h.
GKChallengeStateDeclined The receiving player declined the challenge.available in ios 6.0 and later.declared in gkchallenge.h.
GKLeaderboardTimeScopeToday Each player is restricted to scores recorded in the past 24 hours.available in ios 4.1 and later.declared in gkleaderboard.h.
GKLeaderboardTimeScopeWeek Each player is restricted to scores recorded in the past week.available in ios 4.1 and later.declared in gkleaderboard.h.
GKLeaderboardTimeScopeAllTime Each player’s best score is returned.available in ios 4.1 and later.declared in gkleaderboard.h.
GKLeaderboardPlayerScopeGlobal All players on game center should be considered when generating the list of scores.available in ios 4.1 and later.declared in gkleaderboard.h.
GKLeaderboardPlayerScopeFriendsOnly Only friends of the local player should be considered when generating the list of scores.available in ios 4.1 and later.declared in gkleaderboard.h.
GKMatchSendDataReliable The data is sent continuously until it is successfully received by the intended recipients or the connection times out. use this when you need to guarantee delivery and speed is not critical.reliable transmissions are delivered in the order they were sent.available in ios 4.1 and later.declared in gkmatch.h.
GKMatchSendDataUnreliable The data is sent once and is not sent again if a transmission error occurs. use this for small packets of data that must arrive quickly to be useful to the recipient.data transmitted unreliably may be received out of order by recipients. typically, you build your own game-specific error handling on top of this mechanism.available in ios 4.1 and later.declared in gkmatch.h.
GKPlayerStateUnknown The player is in an indeterminate state and cannot receive data.available in ios 4.1 and later.declared in gkmatch.h.
GKPlayerStateConnected The player is connected to the match and can receive data.available in ios 4.1 and later.declared in gkmatch.h.
GKPlayerStateDisconnected The player is disconnected from the match and cannot receive data.available in ios 4.1 and later.declared in gkmatch.h.
GKMatchTypePeerToPeer A peer-to-peer match hosted by game center. it is represented by a gkmatch object.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKMatchTypeHosted A match hosted on your private server.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKMatchTypeTurnBased A turn-based match hosted by game center. it is represented by a gkturnbasedmatch object.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKInviteeResponseAccepted The player accepted the invitation.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKInviteeResponseDeclined The player rejected the invitation.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKInviteeResponseFailed The invitation was unable to be delivered.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKInviteeResponseIncompatible The invitee is not running a compatible version of your game.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKInviteeResponseUnableToConnect The invitee could not be contacted.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKInviteeResponseNoAnswer The invitation timed out without an answer.available in ios 6.0 and later.declared in gkmatchmaker.h.
GKPeerPickerConnectionTypeOnline An internet-based connection.available in ios 3.0 and later.declared in gkpeerpickercontroller.h.
GKPeerPickerConnectionTypeNearby A bluetooth connection to a device.available in ios 3.0 and later.declared in gkpeerpickercontroller.h.
GKPhotoSizeSmall Load a small photo.available in ios 5.0 and later.declared in gkplayer.h.
GKPhotoSizeNormal Load a normal sized photo.available in ios 5.0 and later.declared in gkplayer.h.
GKSessionErrorDomain An error occurred in gksession.available in ios 3.0 and later.declared in gksessionerror.h.
GKTurnBasedMatchStatusUnknown The match is in an unexpected state.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchStatusOpen The match is currently being played.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchStatusEnded The match has been completed.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchStatusMatching Game center is still searching for other players to join the match.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnTimeoutDefault Indicates that the player has one week to take a turn.available in ios 6.0 and later.declared in gkturnbasedmatch.h.
GKTurnTimeoutNone Indicates that the player’s turn never times out.available in ios 6.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeNone The participant’s outcome has not been set yet (typically because the match is still in progress).available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeQuit The participant forfeited the match.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeWon The participant won the match.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeLost The participant lost the match.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeTied The participant tied the match.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeTimeExpired The participant was ejected from the match because he or she did not act in a timely fashion.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeFirst The participant finished first.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeSecond The participant finished second.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeThird The participant finished third.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeFourth The participant finished fourth.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedMatchOutcomeCustomRange A mask used to allow your game to provide its own custom outcome. any custom value must fit inside the mask.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedParticipantStatusUnknown The participant is in an unexpected state.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedParticipantStatusInvited The participant was invited to the match, but has not responded to the invitation.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedParticipantStatusDeclined The participant declined the invitation to join the match. when a participant declines an invitation to join a match, the match is automatically terminated.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedParticipantStatusMatching The participant represents an unfilled position in the match that game center promises to fill when needed. when you make this participant the next person to take a turn in the match, game center fills the position and updates the status and playerid properties.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedParticipantStatusActive The participant has joined the match and is an active player in it.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKTurnBasedParticipantStatusDone The participant has exited the match. your game sets the matchoutcome property to state why the participant left the match.available in ios 5.0 and later.declared in gkturnbasedmatch.h.
GKVoiceChatPlayerConnected The player connected to the channel.available in ios 4.1 and later.declared in gkvoicechat.h.
GKVoiceChatPlayerDisconnected The player left the channel.available in ios 4.1 and later.declared in gkvoicechat.h.
GKVoiceChatPlayerSpeaking The player began speaking.available in ios 4.1 and later.declared in gkvoicechat.h.
GKVoiceChatPlayerSilent The player stopped speaking.available in ios 4.1 and later.declared in gkvoicechat.h.
GKVoiceChatPlayerConnecting The player is connecting to the channel, but is not yet connected.available in ios 6.0 and later.declared in gkvoicechat.h.
GKVoiceChatServiceErrorDomain An error occurred in gkvoicechatservice.available in ios 3.0 and later.declared in gkvoicechatservice.h.
CATransform3DIdentity The identity transform: [1 0 0 0; 0 1 0 0; 0 0 1 0; 0 0 0 1]. available in ios 2.0 and later.declared in catransform3d.h.
CIFormat The data type for a pixel format.
MKLaunchOptionsDirectionsModeKey The value of this key is an nsstring corresponding to one of the values described in “directions mode values”. you specify this key to tell the maps app to treat the provided map items as start and end points for routing directions. if this key is not present, maps displays pins at the specified locations. available in ios 6.0 and later.declared in mkmapitem.h.
MKLaunchOptionsMapTypeKey The value of this key is an nsnumber object whose value is an integer corresponding to an mkmaptype value. this value represents the type of map (standard, satellite, hybrid) to display. available in ios 6.0 and later.declared in mkmapitem.h.
MKLaunchOptionsMapCenterKey The value of this key is an nsvalue object that contains an encoded cllocationcoordinate2d structure. this value represents the location on which the map view should be centered.available in ios 6.0 and later.declared in mkmapitem.h.
MKLaunchOptionsMapSpanKey The value of this key is an nsvalue object that contains an encoded mkcoordinatespan structure. this value represents the region that the map view should display.available in ios 6.0 and later.declared in mkmapitem.h.
MKLaunchOptionsShowsTrafficKey The value of this key is an nsnumber object that contains a boolean value. this value indicates whether traffic information should be displayed on the map. if you do not specify this key, maps uses its current settings to determine whether or not to display traffic.available in ios 6.0 and later.declared in mkmapitem.h.
MKLaunchOptionsDirectionsModeDriving Tells the maps app to display driving directions between the start and end points.available in ios 6.0 and later.declared in mkmapitem.h.
MKLaunchOptionsDirectionsModeWalking Tells the maps app to display walking directions between the start and end points.available in ios 6.0 and later.declared in mkmapitem.h.
MKMapTypeStandard Displays a street map that shows the position of all roads and some road names. available in ios 3.0 and later.declared in mktypes.h.
MKMapTypeSatellite Displays satellite imagery of the area.available in ios 3.0 and later.declared in mktypes.h.
MKMapTypeHybrid Displays a satellite image of the area with road and road name information layered on top.available in ios 3.0 and later.declared in mktypes.h.
MKUserTrackingModeNone The map does not follow the user location.available in ios 5.0 and later.declared in mkmapview.h.
MKUserTrackingModeFollow The map follows the user location.available in ios 5.0 and later.declared in mkmapview.h.
MKUserTrackingModeFollowWithHeading The map follows the user location and rotates when the heading changes.available in ios 5.0 and later.declared in mkmapview.h.
MKPinAnnotationColorRed The head of the pin is red. red pins indicate destination points on the map.available in ios 3.0 and later.declared in mkpinannotationview.h.
MKPinAnnotationColorGreen The head of the pin is green. green pins indicate starting points on the map.available in ios 3.0 and later.declared in mkpinannotationview.h.
MKPinAnnotationColorPurple The head of the pin is purple. purple pins indicate user-specified points on the map.available in ios 3.0 and later.declared in mkpinannotationview.h.
AVMetadataObjectTypeFace The type string stored in the type property of metadata objects that contain face detection data.available in ios 6.0 and later.declared in avmetadataobject.h.
MPMediaEntityPropertyPersistentID The persistent identifier for a media entity. value is an nsnumber object containing a uint64_t (unsigned long long).can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaentity.h.
MPMediaTypeMusic If set, the media item contains music.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaTypePodcast If set, the media item contains a podcast.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaTypeAudioBook If set, the media item contains an audio book.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaTypeAnyAudio If set, the media item contains an unspecified type of audio content.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaTypeMovie If set, the media item contains a movie.available in ios 5.0 and later.declared in mpmediaitem.h.
MPMediaTypeTVShow If set, the media item contains a tv show.available in ios 5.0 and later.declared in mpmediaitem.h.
MPMediaTypeVideoPodcast If set, the media item contains a video podcast.available in ios 5.0 and later.declared in mpmediaitem.h.
MPMediaTypeMusicVideo If set, the media item contains a music video.available in ios 5.0 and later.declared in mpmediaitem.h.
MPMediaTypeVideoITunesU If set, the media item contains an itunes u video.available in ios 5.0 and later.declared in mpmediaitem.h.
MPMediaTypeAnyVideo If set, the media item contains an unspecified type of video content.available in ios 5.0 and later.declared in mpmediaitem.h.
MPMediaTypeAny If set, the media item contains an unspecified type of audio.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyPersistentID The persistent identifier for the media item. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertypersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAlbumPersistentID The persistent identifier for an album. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertyalbumpersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaitem.h.
MPMediaItemPropertyArtistPersistentID The persistent identifier for an artist. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertyartistpersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAlbumArtistPersistentID The persistent identifier for an album artist. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertyalbumartistpersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaitem.h.
MPMediaItemPropertyGenrePersistentID The persistent identifier for a genre. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertygenrepersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaitem.h.
MPMediaItemPropertyComposerPersistentID The persistent identifier for a composer. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertycomposerpersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaitem.h.
MPMediaItemPropertyPodcastPersistentID The persistent identifier for an audio podcast. value is an nsnumber object containing a uint64_t (unsigned long long).the value of the mpmediaitempropertypodcastpersistentid identifier persists across application launches and across syncs that do not change the sync status of the media item. the value is not guaranteed to persist across a sync/unsync/sync cycle.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 4.2 and later.declared in mpmediaitem.h.
MPMediaItemPropertyMediaType The media type of the media item. value is an an nsnumber object representing an nsinteger data type. the nsinteger value represents a bit field flag, or set of flags, from “media item type flags.”can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyTitle The title (or name) of the media item. this property is unrelated to the mpmediaitempropertyalbumtitle property. value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAlbumTitle The title of an album, such as “live on mars”, as opposed to the title of an individual song on the album, such as “crater dance (radio edit)” (which you specify using the mpmediaitempropertytitle property). value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyArtist The performing artist(s) for a media item—which may vary from the primary artist for the album that a media item belongs to. for example, if the album artist is “joseph fable,” the artist for one of the songs in the album may be “joseph fable featuring thomas smithson”. value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAlbumArtist The primary performing artist for an album as a whole. value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyGenre The musical or film genre of the media item. value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyComposer The musical composer for the media item. value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyPlaybackDuration The playback duration of the media item. value is an nsnumber object representing a duration in seconds as an nstimeinterval.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAlbumTrackNumber The track number of the media item, for a media item that is part of an album. value is an nsnumber object representing an nsuinteger data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAlbumTrackCount The number of tracks in the album that contains the media item. value is an nsnumber object representing an nsuinteger data type.for an audio streaming app, the system provides a default value of 1 for this property.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyDiscNumber The disc number of the media item, for a media item that is part of a multi-disc album. value is an nsnumber object representing an nsuinteger data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyDiscCount The number of discs in the album that contains the media item. value is an nsnumber object representing an nsuinteger data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyArtwork The artwork image for the media item. value is a media item image, described in mpmediaitemartwork class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyLyrics The lyrics for the media item. value is an nsstring object.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyIsCompilation A boolean value indicating whether the media item is part of a compilation (yes), or not (no). corresponds to the the “part of a compilation” checkbox in the info tab in the get info dialog in itunes. value is an nsnumber object representing a bool data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyReleaseDate The date on which the media item was first publicly released. value is an nsdate object.available in ios 4.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyBeatsPerMinute The number of musical beats per minute for the media item, corresponding to the “bpm” field in the info tab in the get info dialog in itunes. value is an nsnumber object representing an nsuinteger data type.available in ios 4.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyComments Textual information about the media item, corresponding to the “comments” field in in the info tab in the get info dialog in itunes. value is an nsstring object.available in ios 4.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyAssetURL A url pointing to the media item, from which an avasset object (or other url-based av foundation object) can be created, with any options as desired. value is an nsurl object.the url has the custom scheme of ipod-library. for example, a url might look like this:ipod-library://item/item.m4a?id=12345usage of the url outside of the av foundation framework is not supported.available in ios 4.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyIsCloudItem A boolean value indicating whether the media item is an icloud item (yes), or not (no). a media item is considered an icloud item if it is available via itunes match and is not already stored on the device. value is an nsnumber object representing a bool data type.available in ios 6.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyPodcastTitle The title of a podcast, such as “this martian drudgery”, as opposed to the title of an individual episode of a podcast such as “episode 12: another cold day at the pole” (which you specify using the mpmediaitempropertytitle property). value is an nsstring object.can be used to build a media property predicate as described in mpmediapropertypredicate class reference.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyPlayCount The number of times the user has played the media item. value is an nsnumber object representing an nsuinteger data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertySkipCount The number of times the user has skipped playing the item. value is an nsnumber object representing an nsuinteger data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyRating The user-specified rating of the object in the range [0...5], where a value of 5 indicates the most favorable rating. value is an nsnumber object representing an nsuinteger data type.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyLastPlayedDate The most recent calendar date on which the user played the media item. value is an nsdate object.available in ios 3.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyUserGrouping Corresponds to the “grouping” field in the info tab in the get info dialog in itunes. value is an nsstring object.available in ios 4.0 and later.declared in mpmediaitem.h.
MPMediaItemPropertyBookmarkTime The user’s place in the media item the most recent time it was played. value is an nsnumber object representing a duration in seconds as an nstimeinterval.available in ios 6.0 and later.declared in mpmediaitem.h.
MPMediaPlaylistAttributeNone If set, the playlist has no attributes.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistAttributeOnTheGo If set, the playlist was created on a device rather than synced from itunes.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistAttributeSmart If set, the playlist is a “smart” playlist, whose members are determined by user-specified rules.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistAttributeGenius If set, the playlist is a genius playlist. available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistPropertyPersistentID The persistent identifier for the playlist. value is an nsnumber object containing a uint64_t (unsigned long long).can be used to build a media property predicate as described in mpmediaquery class reference.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistPropertyName The name of the playlist. value is an nsstring object.can be used to build a media property predicate as described in mpmediaquery class reference.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistPropertyPlaylistAttributes The attributes associated with the playlist. value is an nsnumber object containing an nsinteger data type. fields in the nsinteger identify the attributes of the playlist. a playlist may have any combination of attributes described in “playlist attribute flags.”can be used to build a media property predicate as described in mpmediaquery class reference.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPlaylistPropertySeedItems The items seeded to generate the playlist; applies only to genius playlists. value is an nsarray object containing one or more mpmediaitem objects. value is nil for playlists that do not have the mpmediaplaylistattributegenius flag set.available in ios 3.0 and later.declared in mpmediaplaylist.h.
MPMediaPredicateComparisonEqualTo Matches when a media item’s value for a given property is equal to the value in the media property predicate.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaPredicateComparisonContains Matches when a media item’s value for a given property is contained in the value of the media property predicate.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingTitle Groups and sorts media item collections by title. for songs, for example, the title is the song name. this is the default grouping key.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingAlbum Groups and sorts media item collections by album, and sorts songs within an album by track order.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingArtist Groups and sorts media item collections by performing artist.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingAlbumArtist Groups and sorts media item collections by album artist (the primary performing artist for an album as a whole).available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingComposer Groups and sorts media item collections by composer.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingGenre Groups and sorts media item collections by musical or film genre.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingPlaylist Groups and sorts media item collections by playlist.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMediaGroupingPodcastTitle Groups and sorts media item collections by podcast title.available in ios 3.0 and later.declared in mpmediaquery.h.
MPMovieLoadStateUnknown The load state is not known.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieLoadStatePlayable The buffer has enough data that playback can begin, but it may run out of data before playback finishes.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieLoadStatePlaythroughOK Enough data has been buffered for playback to continue uninterrupted.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieLoadStateStalled The buffering of data has stalled. if started now, playback may pause automatically if the player runs out of buffered data.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieControlStyleNone No controls are displayed.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieControlStyleEmbedded Controls for an embedded view are displayed. the controls include a start/pause button, a scrubber bar, and a button for toggling between fullscreen and embedded display modes.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieControlStyleFullscreen Controls for fullscreen playback are displayed. the controls include a start/pause button, a scrubber bar, forward and reverse seeking buttons, a button for toggling between fullscreen and embedded display modes, a button for toggling the aspect fill mode, and a done button. tapping the done button pauses the video and exits fullscreen mode.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieControlStyleDefault Fullscreen controls are displayed by default. available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieFinishReasonPlaybackEnded The end of the movie was reached.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieFinishReasonPlaybackError There was an error during playback.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieFinishReasonUserExited The user stopped playback.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlaybackStateStopped Playback is currently stopped. playback will commence from the beginning of the movie.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlaybackStatePlaying Playback is currently under way.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlaybackStatePaused Playback is currently paused. playback will resume from the point where it was paused.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlaybackStateInterrupted Playback is temporarily interrupted, perhaps because the buffer ran out of content.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlaybackStateSeekingForward The movie player is currently seeking towards the end of the movie.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlaybackStateSeekingBackward The movie player is currently seeking towards the beginning of the movie.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieRepeatModeNone Content is not repeated when playback finishesavailable in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieRepeatModeOne The current movie is repeated when it finishes.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieTimeOptionNearestKeyFrame Generate a thumbnail image using the nearest key frame. this frame could be several frames away from the current frame. this option generally offers better performance than trying to find the exact frame.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieTimeOptionExact Use the exact current frame. available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieMediaTypeMaskNone The types of media available in the media are not yet known.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieMediaTypeMaskVideo The movie file contains video media.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieMediaTypeMaskAudio The movie file contains audio media.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieSourceTypeUnknown The movie type is not yet known.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieSourceTypeFile The movie is a local file or is a file that can be downloaded from the network. available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMovieSourceTypeStreaming The movie is a live or on-demand stream. available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerThumbnailImageKey The value of this key is a uiimage object containing the image that was obtained for the desired frame.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerThumbnailTimeKey The value of this key is a nsnumber object containing a double value. this value represents the actual time (measured in seconds) from the beginning of the movie at which the image was captured.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerThumbnailErrorKey The value of this key is an nserror object identifying the error that occurred, if any.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerFullscreenAnimationDurationUserInfoKey The value of this key is an nsnumber containing a double value. this value represents the duration (measured in seconds) of the animation used to transition in or out of full-screen mode.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerFullscreenAnimationCurveUserInfoKey The value of this key is an nsnumber containing an integer value that represents one of the uiviewanimationcurve constants.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerPlaybackDidFinishReasonUserInfoKey The value of this key is an nsnumber containing an integer value that represents one of the “mpmoviefinishreason” constants.available in ios 3.2 and later.declared in mpmovieplayercontroller.h.
MPMusicPlaybackStateStopped The music player is stopped.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicPlaybackStatePlaying The music player is playing.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicPlaybackStatePaused The music player is paused.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicPlaybackStateInterrupted The music player has been interrupted, such as by an incoming phone call.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicPlaybackStateSeekingForward The music player is seeking forward.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicPlaybackStateSeekingBackward The music player is seeking backward.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicRepeatModeDefault The user’s preferred repeat mode.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicRepeatModeNone The music player will not repeat the current song or playlist.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicRepeatModeOne The music player will repeat the current song.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicRepeatModeAll The music player will repeat the current playlist.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicShuffleModeDefault The user’s preferred shuffle mode.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicShuffleModeOff The playlist is not shuffled.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicShuffleModeSongs The playlist is shuffled by song.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPMusicShuffleModeAlbums The playlist is shuffled by album.available in ios 3.0 and later.declared in mpmusicplayercontroller.h.
MPNowPlayingInfoPropertyElapsedPlaybackTime The elapsed time of the now playing item, in seconds.value is an nsnumber object configured as a double. elapsed time is automatically calculated, by the system, from the previously provided elapsed time and the playback rate. do not update this property frequently—it is not necessary.available in ios 5.0 and later.declared in mpnowplayinginfocenter.h.
MPNowPlayingInfoPropertyPlaybackRate The playback rate of the now-playing item, with a value of 1.0 indicating the normal playback rate.value is an nsnumber object configured as a double. the default value is 1.0. a playback rate value of 2.0 means twice the normal playback rate; a piece of media played at this rate would take half as long to play to completion. a value of 0.5 means half the normal playback rate; a piece of media played at this rate would take twice as long to play to completion.available in ios 5.0 and later.declared in mpnowplayinginfocenter.h.
MPNowPlayingInfoPropertyPlaybackQueueIndex The index of the now-playing item in the app’s playback queue.value is an nsnumber object configured as an nsuinteger. the playback queue uses zero-based indexing. if you want the first item in the queue to be displayed as “item 1 of 10,” for example, set the item’s index to 0.available in ios 5.0 and later.declared in mpnowplayinginfocenter.h.
MPNowPlayingInfoPropertyPlaybackQueueCount The total number of items in the app’s playback queue.value is an nsnumber object configured as an nsuinteger.available in ios 5.0 and later.declared in mpnowplayinginfocenter.h.
MPNowPlayingInfoPropertyChapterNumber The number corresponding to the chapter currently being played.value is an nsnumber object configured as an nsuinteger. chapter numbering uses zero-based indexing. if you want the first chapter in the now-playing item to be displayed as “chapter 1,” for example, set the chapter number to 0.available in ios 5.0 and later.declared in mpnowplayinginfocenter.h.
MPNowPlayingInfoPropertyChapterCount The total number of chapters in the now-playing item.value is an nsnumber object configured as an nsuinteger.available in ios 5.0 and later.declared in mpnowplayinginfocenter.h.
MPMoviePlayerTimedMetadataKeyName The name of the timed metadata key.available in ios 4.0 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerTimedMetadataKeyInfo Arbitrary information about the timed metadata.available in ios 4.0 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerTimedMetadataKeyMIMEType The mime type for the timed metadata.available in ios 4.0 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerTimedMetadataKeyDataType The data type of the timed metadata.available in ios 4.0 and later.declared in mpmovieplayercontroller.h.
MPMoviePlayerTimedMetadataKeyLanguageCode The metadata language, expressed using iso 639-2, in a string object.available in ios 4.0 and later.declared in mpmovieplayercontroller.h.
MFMailComposeResultCancelled The user cancelled the operation. no email message was queued.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MFMailComposeResultSaved The email message was saved in the user’s drafts folder.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MFMailComposeResultSent The email message was queued in the user’s outbox. it is ready to send the next time the user connects to email.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MFMailComposeResultFailed The email message was not saved or queued, possibly due to an error.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MFMailComposeErrorDomain The error domain associated with nserror objects.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MFMailComposeErrorCodeSaveFailed An error occurred trying to save the email message to the drafts folder.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MFMailComposeErrorCodeSendFailed An error occurred while trying to queue or send the email message.available in ios 3.0 and later.declared in mfmailcomposeviewcontroller.h.
MessageComposeResultCancelled The user canceled the composition.available in ios 4.0 and later.declared in mfmessagecomposeviewcontroller.h.
MessageComposeResultSent The user successfully queued or sent the message. available in ios 4.0 and later.declared in mfmessagecomposeviewcontroller.h.
MessageComposeResultFailed The user’s attempt to save or send the message was unsuccessful.available in ios 4.0 and later.declared in mfmessagecomposeviewcontroller.h.
MFMessageComposeViewControllerTextMessageAvailabilityKey The value of this key is an nsnumber object containing a boolean value. this value matches the result of the cansendtext class method.available in ios 5.0 and later.declared in mfmessagecomposeviewcontroller.h.
CTCallStateDialing The call state, before connection is established, when the user initiates the call.available in ios 4.0 and later.declared in ctcall.h.
CTCallStateIncoming The call state, before connection is established, when a call is incoming but not yet answered by the user.available in ios 4.0 and later.declared in ctcall.h.
CTCallStateConnected The call state when the call is fully established for all parties involved.available in ios 4.0 and later.declared in ctcall.h.
CTCallStateDisconnected The call state upon call termination.available in ios 4.0 and later.declared in ctcall.h.
SLComposeViewControllerResultCancelled The view controller is dismissed without sending the post. for example, the user selects cancel or the account is not available.available in ios 6.0 and later.declared in slcomposeviewcontroller.h.
SLComposeViewControllerResultDone The view controller is dismissed and the message is being sent in the background. this occurs when the user selects done.available in ios 6.0 and later.declared in slcomposeviewcontroller.h.
PKPassKitErrorDomain Error domain for passkit errors.available in ios 6.0 and later.declared in pkpass.h.
PKUnknownError Unknown error.available in ios 6.0 and later.declared in pkpass.h.
PKInvalidDataError Invalid pass data.available in ios 6.0 and later.declared in pkpass.h.
PKUnsupportedVersionError Unsupported pass version.available in ios 6.0 and later.declared in pkpass.h.
PKCertificateRevokedError Pass signed by a revoked certificate.
PKPassLibraryAddedPassesUserInfoKey An array of the pkpass objects that were added.available in ios 6.0 and later.declared in pkpasslibrary.h.
PKPassLibraryRemovedPassInfosUserInfoKey An array of dictionaries describing the passes that were removed.the dictionary contains the keys pkpasslibrarypasstypeidentifieruserinfokey and pkpasslibraryserialnumberuserinfokey.available in ios 6.0 and later.declared in pkpasslibrary.h.
PKPassLibraryReplacementPassesUserInfoKey An array of the pkpass objects that were replaced.available in ios 6.0 and later.declared in pkpasslibrary.h.
PKPassLibraryPassTypeIdentifierUserInfoKey The pass type identifier of the pass.used by the dictionary that is the value of pkpasslibraryremovedpassinfosuserinfokey.available in ios 6.0 and later.declared in pkpasslibrary.h.
PKPassLibrarySerialNumberUserInfoKey The serial number of the pass.used by the dictionary that is the value of pkpasslibraryremovedpassinfosuserinfokey.available in ios 6.0 and later.declared in pkpasslibrary.h.
SLServiceTypeFacebook A string constant that identifies the social networking site, facebook.available in ios 6.0 and later.declared in slservicetypes.h.
SLServiceTypeTwitter A string constant that identifies the social networking site, twitter.available in ios 6.0 and later.declared in slservicetypes.h.
SLServiceTypeSinaWeibo A string constant that identifies the social networking site, sina weibo.available in ios 6.0 and later.declared in slservicetypes.h.
SLRequestMethodGET Requests information from the specified resource. use a get request to fetch information from the specified server such as character limits or a user’s timeline.available in ios 6.0 and later.declared in slrequest.h.
SLRequestMethodPOST Submits data to be processed. use a post request to submit information to the specified server such as a status update or an image.available in ios 6.0 and later.declared in slrequest.h.
SLRequestMethodDELETE Deletes the specified resource.available in ios 6.0 and later.declared in slrequest.h.
SKDownloadStateWaiting Indicates that the download has not started yet.available in ios 6.0 and later.declared in skdownload.h.
SKDownloadStateActive Indicates that the content is currently being downloaded.available in ios 6.0 and later.declared in skdownload.h.
SKDownloadStatePaused Indicates that your app paused the download.available in ios 6.0 and later.declared in skdownload.h.
SKDownloadStateFinished Indicates that the content was successfully downloaded.available in ios 6.0 and later.declared in skdownload.h.
SKDownloadStateFailed Indicates that an error occurred while the file was being downloaded.available in ios 6.0 and later.declared in skdownload.h.
SKDownloadStateCancelled Indicates that your app canceled the download.available in ios 6.0 and later.declared in skdownload.h.
SKDownloadTimeRemainingUnknown Indicates that the system cannot determine how much time is needed to finish downloading the content.available in ios 6.0 and later.declared in skdownload.h.
SKStoreProductParameterITunesItemIdentifier The value associated with this key should be a string representing the itunes identifier for the item you want the store to display when the view controller is presented.available in ios 6.0 and later.declared in skstoreproductviewcontroller.h.
SKPaymentTransactionStatePurchasing The transaction is being processed by the app store.available in ios 3.0 and later.declared in skpaymenttransaction.h.
SKPaymentTransactionStatePurchased The app store successfully processed payment. your application should provide the content the user purchased.available in ios 3.0 and later.declared in skpaymenttransaction.h.
SKPaymentTransactionStateFailed The transaction failed. check the error property to determine what happened.available in ios 3.0 and later.declared in skpaymenttransaction.h.
SKPaymentTransactionStateRestored This transaction restores content previously purchased by the user. read the originaltransaction property to obtain information about the original purchase.available in ios 3.0 and later.declared in skpaymenttransaction.h.
UIAccessibilityTraitNone The accessibility element has no traits.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitButton The accessibility element should be treated as a button.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitLink The accessibility element should be treated as a link.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitSearchField The accessibility element should be treated as a search field.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitImage The accessibility element should be treated as an image.this trait can be combined with the button or link traits.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitSelected The accessibility element is currently selected.you can use this trait to characterize an accessibility element that represents, for example, a selected table row or a selected segment in a segmented control.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitPlaysSound The accessibility element plays its own sound when activated.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitKeyboardKey The accessibility element behaves as a keyboard key.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitStaticText The accessibility element should be treated as static text that cannot change.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitSummaryElement The accessibility element provides summary information when the application starts.you can use this trait to characterize an accessibility element that provides a summary of current conditions, settings, or state, such as the current temperature in the weather application.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitNotEnabled The accessibility element is not enabled and does not respond to user interaction.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitUpdatesFrequently The accessibility element frequently updates its label or value.you can use this trait to characterize an accessibility element that updates its label or value too often to send update notifications. include this trait when you want an assistive application to avoid handling continual notifications and, instead, poll for changes when it needs updated information. for example, you might use this trait to characterize the readout of a stopwatch.available in ios 3.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitStartsMediaSession The accessibility element starts a media session when it is activated.you can use this trait to silence the audio output of an assistive technology, such as voiceover, during a media session that should not be interrupted. for example, you might use this trait to silence voiceover speech while the user is recording audio.available in ios 4.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitAdjustable The accessibility element allows continuous adjustment through a range of values.you can use this trait to characterize an accessibility element that users can adjust in a continuous manner, such as a slider or a picker view. if you specify this trait on an accessibility element, you must also implement the accessibilityincrement and accessibilitydecrement methods in the uiaccessibilityaction protocol.available in ios 4.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitAllowsDirectInteraction The accessibility element allows direct touch interaction for voiceover users.you can use this trait to characterize an accessibility element that represents an object that users interact with directly, such as a view that represents a piano keyboard.available in ios 5.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitCausesPageTurn The accessibility element should cause an automatic page turn when voiceover finishes reading the text within it.you can use this trait to characterize an accessibility element that represents a page of content within a set of pages, such as view that represents a page in a book. when voiceover finishes reading the content in the current page, it calls accessibilityscroll with uiaccessibilityscrolldirectionnext to scroll to the next content page. if voiceover detects that the new content does not differ from the previous content, it stops scrolling.available in ios 5.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityTraitHeader The accessibility element is a header that divides content into sections, such as the title of a navigation bar.available in ios 6.0 and later.declared in uiaccessibilityconstants.h.
UIAccessibilityZoomTypeInsertionPoint The system zoom type is the text insertion point.available in ios 5.0 and later.declared in uiaccessibilityzoom.h.
AVPlayerStatusUnknown Indicates that the status of the player is not yet known because it has not tried to load new media resources for playback.available in ios 4.0 and later.declared in avplayer.h.
AVPlayerStatusReadyToPlay Indicates that the player is ready to play avplayeritem instances.available in ios 4.0 and later.declared in avplayer.h.
AVPlayerStatusFailed Indicates that the player can no longer play avplayeritem instances because of an error.the error is described by the value of the player’s error property.available in ios 4.0 and later.declared in avplayer.h.
AVPlayerActionAtItemEndAdvance Indicates that the player should advance to the next item, if there is one.available in ios 4.1 and later.declared in avplayer.h.
AVPlayerActionAtItemEndPause Indicates that the player should pause playing.available in ios 4.0 and later.declared in avplayer.h.
AVPlayerActionAtItemEndNone Indicates that the player should do nothing.available in ios 4.0 and later.declared in avplayer.h.
UIActivityTypePostToFacebook The object posts the provided content to the user’s wall on facebook. when using this service, you can provide nsstring, nsattributedstring, uiimage, avasset, and nsurl objects as data for the activity items. you may also specify nsurl objects whose contents use the assets-library scheme.available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypePostToTwitter The object posts the provided content to the user’s twitter feed. when using this service, you can provide nsstring, nsattributedstring, uiimage, avasset, and nsurl objects as data for the activity items. you may also specify nsurl objects whose contents use the assets-library scheme. available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypePostToWeibo The object posts the provided content to the user’s wall weibo feed. when using this service, you can provide nsstring, nsattributedstring, uiimage, avasset, and nsurl objects as data for the activity items. you may also specify nsurl objects whose contents use the assets-library scheme.available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypeMessage The object posts the provided content to the messages app. when using this service, you can provide nsstring and nsattributedstring objects as data for the activity items. you may also specify nsurl objects whose contents use the sms scheme. available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypeMail The object posts the provided content to a new email message. when using this service, you can provide nsstring and uiimage objects and nsurl objects pointing to local files as data for the activity items. you may also specify nsurl objects whose contents use the mailto scheme. available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypePrint The object prints the provided content. when using this service, you can provide uiimage and nsdata objects and nsurl objects pointing to local files as data for the activity items. you can also provide uiprintpagerenderer, uiprintformatter, and uiprintinfo objects. available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypeCopyToPasteboard The object posts the provided content to the pasteboard. when using this service, you can provide nsstring, uiimage, nsurl, uicolor, and nsdictionary objects as data for the activity items. available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypeAssignToContact The object assigns the image to a contact. when using this service, you can provide a uiimage object as data for the activity items. available in ios 6.0 and later.declared in uiactivity.h.
UIActivityTypeSaveToCameraRoll The object assigns the image or video to the user’s camera roll. when using this service, you can provide a uiimage object as data for image-based activity items. for video items, you can provide an nsurl object with a pointer to the video. available in ios 6.0 and later.declared in uiactivity.h.
AVPlayerItemStatusUnknown The item’s status is unknown.available in ios 4.0 and later.declared in avplayeritem.h.
AVPlayerItemStatusReadyToPlay The item is ready to play.available in ios 4.0 and later.declared in avplayeritem.h.
AVPlayerItemStatusFailed The item cannot be played.available in ios 4.0 and later.declared in avplayeritem.h.
AVPlayerItemFailedToPlayToEndTimeErrorKey The key to retrieve an error object (nserror) from the user info dictionary of an avplayeritemtimejumpednotification notification.available in ios 4.3 and later.declared in avplayeritem.h.
UITrackingRunLoopMode The mode set while tracking in controls takes place. you can use this mode to add timers that fire during tracking.available in ios 2.0 and later.declared in uiapplication.h.
UIApplicationStatusBarOrientationUserInfoKey Accesses an nsnumber object that encapsulates a uiinterfaceorientation value indicating the current orientation (see uiinterfaceorientation). this key is used with uiapplicationdidchangestatusbarorientationnotification and uiapplicationwillchangestatusbarorientationnotification notifications.available in ios 2.0 and later.declared in uiapplication.h.
UIApplicationStatusBarFrameUserInfoKey Accesses an nsvalue object that encapsulates a cgrect structure expressing the location and size of the new status bar frame. this key is used with uiapplicationdidchangestatusbarframenotification and uiapplicationwillchangestatusbarframenotification notifications.available in ios 2.0 and later.declared in uiapplication.h.
UIBackgroundTaskInvalid An token indicating an invalid task request. this constant should be used to initialize variables or to check for errors. available in ios 4.0 and later.declared in uiapplication.h.
UIMinimumKeepAliveTimeout The minimum amount of time (measured in seconds) an application may run a critical background task in the background.available in ios 4.0 and later.declared in uiapplication.h.
UIApplicationStateActive The application is running in the foreground and currently receiving events.available in ios 4.0 and later.declared in uiapplication.h.
UIApplicationStateInactive The application is running in the foreground but is not receiving events. this might happen as a result of an interruption or because the application is transitioning to or from the background.available in ios 4.0 and later.declared in uiapplication.h.
UIApplicationStateBackground The application is running in the background.available in ios 4.0 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsURLKey The presence of this key indicates that the application was launched in order to open a url. the value of this key is an nsurl object containing the url to open. this key is also used to access the same value in the userinfo dictionary of the notification named uiapplicationdidfinishlaunchingnotification.available in ios 3.0 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsSourceApplicationKey The presence of this key identifies the app that requested the launch of your app. the value of this key is an nsstring object that represents the bundle id of the app that made the request. this key is also used to access the same value in the userinfo dictionary of the notification named uiapplicationdidfinishlaunchingnotification.available in ios 3.0 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsRemoteNotificationKey The presence of this key indicates that a remote notification is available for the app to process. the value of this key is an nsdictionary containing the payload of the remote notification. see the description of application:didreceiveremotenotification: for further information about handling remote notifications.this key is also used to access the same value in the userinfo dictionary of the notification named uiapplicationdidfinishlaunchingnotification.available in ios 3.0 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsAnnotationKey The presence of this key indicates that custom data was provided by the app that requested the opening of the url. the value of this key is a property-list object containing the custom data. the same object is also passed to the annotation parameter of the application:openurl:sourceapplication:annotation: method. the contents of this property-list object are specific to the app that made the request.available in ios 3.2 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsLocalNotificationKey The presence of this key indicates that a local notification is available for the app to process. the value of this key is the uilocalnotification object that was triggered. for additional information about handling local notifications, see the application:didreceivelocalnotification: method. this key is also used to access the same value in the userinfo dictionary of the notification named uiapplicationdidfinishlaunchingnotification.available in ios 4.0 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsLocationKey The presence of this key indicates that the application was launched in response to an incoming location event. the value of this key is an nsnumber object containing a boolean value. you should use the presence of this key as a signal to create a cllocationmanager object and start location services again. location data is delivered only to the location manager delegate and not using this key. available in ios 4.0 and later.declared in uiapplication.h.
UIApplicationLaunchOptionsNewsstandDownloadsKey The presence of this key indicates that newly downloaded newsstand assets are available for your app. the value of this key is an array of string identifiers that identify the nkassetdownload objects corresponding to the assets. although you can use the identifiers for cross-checking purposes, you should obtain the definitive array of nkassetdownload objects (representing asset downloads in progress or in error) through the downloadingassets property of the nklibrary object representing the newsstand application’s library.available in ios 5.0 and later.declared in uiapplication.h.
UIApplicationStateRestorationUserInterfaceIdiomKey The value of this key is an nsnumber object containing one of the values for the uiuserinterfaceidiom enum. this value reflects whether the interface that was saved was targeting the ipad or iphone idiom. available in ios 6.0 and later.declared in uistaterestoration.h.
UIApplicationStateRestorationBundleVersionKey The value of this key is an nsstring object that identifies the version of your app (as obtained from the cfbundleversion key of your app’s info.plist file) was was present when the state information was saved. you can use the value of this key to help make choices about how to proceed during state restoration. for example, if the key indicates that the state is associated with an older version of your app, you might want to avoid restoring the previous state altogether or modify the restoration process more significantly.available in ios 6.0 and later.declared in uistaterestoration.h.
UIRectCornerTopLeft The top-left corner of the rectangle.available in ios 3.2 and later.declared in uibezierpath.h.
UIRectCornerTopRight The top-right corner of the rectangle.available in ios 3.2 and later.declared in uibezierpath.h.
UIRectCornerBottomLeft The bottom-left corner of the rectangle.available in ios 3.2 and later.declared in uibezierpath.h.
UIRectCornerBottomRight The bottom-right corner of the rectangle.available in ios 3.2 and later.declared in uibezierpath.h.
UIRectCornerAllCorners All corners of the rectangle.available in ios 3.2 and later.declared in uibezierpath.h.
UICollectionViewScrollPositionNone Do not scroll the item into view.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollPositionTop Scroll so that the item is positioned at the top of the collection view’s bounds. this option is mutually exclusive with the uicollectionviewscrollpositioncenteredvertically and uicollectionviewscrollpositionbottom options.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollPositionCenteredVertically Scroll so that the item is centered vertically in the collection view. this option is mutually exclusive with the uicollectionviewscrollpositiontop and uicollectionviewscrollpositionbottom options.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollPositionBottom Scroll so that the item is positioned at the bottom of the collection view’s bounds. this option is mutually exclusive with the uicollectionviewscrollpositiontop and uicollectionviewscrollpositioncenteredvertically options.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollPositionLeft Scroll so that the item is positioned at the left edge of the collection view’s bounds. this option is mutually exclusive with the uicollectionviewscrollpositioncenteredhorizontally and uicollectionviewscrollpositionright options.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollPositionCenteredHorizontally Scroll so that the item is centered horizontally in the collection view. this option is mutually exclusive with the uicollectionviewscrollpositionleft and uicollectionviewscrollpositionright options.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollPositionRight Scroll so that the item is positioned at the right edge of the collection view’s bounds. this option is mutually exclusive with the uicollectionviewscrollpositionleft and uicollectionviewscrollpositioncenteredhorizontally options.available in ios 6.0 and later.declared in uicollectionview.h.
UICollectionViewScrollDirectionVertical The layout scrolls content vertically.available in ios 6.0 and later.declared in uicollectionviewflowlayout.h.
UICollectionViewScrollDirectionHorizontal The layout scrolls content horizontally.available in ios 6.0 and later.declared in uicollectionviewflowlayout.h.
UICollectionElementKindSectionHeader A supplementary view that identifies the header for a given section. available in ios 6.0 and later.declared in uicollectionviewflowlayout.h.
UICollectionElementKindSectionFooter A supplementary view that identifies the footer for a given section. available in ios 6.0 and later.declared in uicollectionviewflowlayout.h.
UICollectionUpdateActionNone Take no action on the item.available in ios 6.0 and later.declared in uicollectionviewlayout.h.
UICollectionUpdateActionInsert Insert the item into the collection view.available in ios 6.0 and later.declared in uicollectionviewlayout.h.
UICollectionUpdateActionDelete Remove the item from the collection view.available in ios 6.0 and later.declared in uicollectionviewlayout.h.
UICollectionUpdateActionReload Reload the item, which consists of deleting and then inserting the item.available in ios 6.0 and later.declared in uicollectionviewlayout.h.
UICollectionUpdateActionMove Move the item from its current location to a new location.available in ios 6.0 and later.declared in uicollectionviewlayout.h.
UIControlEventTouchDown A touch-down event in the control.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchDownRepeat A repeated touch-down event in the control; for this event the value of the uitouch tapcount method is greater than one.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchDragInside An event where a finger is dragged inside the bounds of the control.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchDragOutside An event where a finger is dragged just outside the bounds of the control. available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchDragEnter An event where a finger is dragged into the bounds of the control.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchDragExit An event where a finger is dragged from within a control to outside its bounds.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchUpInside A touch-up event in the control where the finger is inside the bounds of the control. available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchUpOutside A touch-up event in the control where the finger is outside the bounds of the control. available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventTouchCancel A system event canceling the current touches for the control.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventValueChanged A touch dragging or otherwise manipulating a control, causing it to emit a series of different values.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventEditingDidBegin A touch initiating an editing session in a uitextfield object by entering its bounds.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventEditingChanged A touch making an editing change in a uitextfield objet.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventEditingDidEnd A touch ending an editing session in a uitextfield object by leaving its bounds.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventEditingDidEndOnExit A touch ending an editing session in a uitextfield object.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventAllTouchEvents All touch events.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventAllEditingEvents All editing touches for uitextfield objects.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventApplicationReserved A range of control-event values available for application use.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventSystemReserved A range of control-event values reserved for internal framework use.available in ios 2.0 and later.declared in uicontrol.h.
UIControlEventAllEvents All events, including system events.available in ios 2.0 and later.declared in uicontrol.h.
UIControlContentVerticalAlignmentCenter Aligns the content vertically in the center of the control.available in ios 2.0 and later.declared in uicontrol.h.
UIControlContentVerticalAlignmentTop Aligns the content vertically at the top in the control (the default).available in ios 2.0 and later.declared in uicontrol.h.
UIControlContentVerticalAlignmentBottom Aligns the content vertically at the bottom in the controlavailable in ios 2.0 and later.declared in uicontrol.h.
UIControlContentVerticalAlignmentFill Aligns the content vertically to fill the content rectangle; images may be stretched.available in ios 2.0 and later.declared in uicontrol.h.
UIDocumentChangeDone A change has beed made to the document.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentChangeUndone A change to the document has been undone.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentChangeRedone An undone change to the document has been redone.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentChangeCleared The document is cleared of outstanding changes. available in ios 5.0 and later.declared in uidocument.h.
UIDocumentSaveForCreating The document is being saved for the first time.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentSaveForOverwriting The document is being saved by overwriting the current version.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentStateNormal The document is open, editing is enabled, and there are no conflicts or errors associated with it.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentStateClosed The document has either not been successfully opened, or has been since closed. the document properties might not be valid.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentStateInConflict Conflicts exist for the document file located at fileurl. you can access these conflicting document versions by calling the otherversionsofitematurl: class method of the nsfileversion class. this method returns an array of nsfileversion objects. you can then resolve the conflicting versions—for example, programmatically attempt to merge the versions or present the document versions to the user and request him or her to pick one.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentStateSavingError An error has occurred that prevents the document from saving.available in ios 5.0 and later.declared in uidocument.h.
UIDocumentStateEditingDisabled The document is busy and it is not currently safe for user edits. this state is set just before uidocument calls the disableediting method. it calls enableediting when it becomes safe to edit again. uidocument also sets this state when an error prevents the reverting of a document. available in ios 5.0 and later.declared in uidocument.h.
UIImagePickerControllerSourceTypePhotoLibrary Specifies the device’s photo library as the source for the image picker controller.available in ios 2.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerSourceTypeCamera Specifies the device’s built-in camera as the source for the image picker controller. indicate the specific camera you want (front or rear, as available) by using the cameradevice property.available in ios 2.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerSourceTypeSavedPhotosAlbum Specifies the device’s camera roll album as the source for the image picker controller. if the device does not have a camera, specifies the saved photos album as the source.available in ios 2.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerQualityTypeHigh If recording, specifies that you want to use the highest-quality video recording supported for the active camera on the device.recorded files are suitable for on-device playback and for wired transfer to the desktop using image capture; they are likely to be too large for transfer using wi-fi.if displaying a recorded movie in the image picker, specifies that you do not want to reduce the video quality of the movie.available in ios 3.1 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerQualityType640x480 If recording, specifies that you want to use vga-quality video recording (pixel dimensions of 640x480).if displaying a recorded movie in the image picker, specifies that you want to transcode higher-quality movies to vga video quality.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerQualityTypeMedium If recording, specifies that you want to use medium-quality video recording.recorded files can usually be transferred using wi-fi. this is the default video quality setting.if displaying a recorded movie in the image picker, specifies that you want to transcode higher-quality movies to medium video quality.available in ios 3.1 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerQualityTypeLow If recording, specifies that you want to use low-quality video recording.recorded files can usually be transferred over the cellular network.if displaying a recorded movie in the image picker, specifies that you want to transcode higher-quality movies to low video quality.available in ios 3.1 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerQualityTypeIFrame1280x720 If recording, specifies that you want to use 1280x720 iframe format.the apple iframe format supports video editing by keeping content in its native recorded format while editing.available in ios 5.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerQualityTypeIFrame960x540 If recording, specifies that you want to use 960x540 iframe format.the apple iframe format supports video editing by keeping content in its native recorded format while editing.available in ios 5.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraDeviceRear Specifies the camera on the rear of the device.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraDeviceFront Specifies the camera on the front of the device.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraCaptureModePhoto Specifies that the camera captures still images.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraCaptureModeVideo Specifies that the camera captures movies.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraFlashModeOff Specifies that flash illumination is always off, no matter what the ambient light conditions are.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraFlashModeAuto Specifies that the device should consider ambient light conditions to automatically determine whether or not to use flash illumination.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCameraFlashModeOn Specifies that flash illumination is always on, no matter what the ambient light conditions are.available in ios 4.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerMediaType Specifies the media type selected by the user.the value for this key is an nsstring object containing a type code such as kuttypeimage or kuttypemovie.available in ios 3.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerOriginalImage Specifies the original, uncropped image selected by the user.the value for this key is a uiimage object. available in ios 2.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerEditedImage Specifies an image edited by the user.the value for this key is a uiimage object.available in ios 3.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerCropRect Specifies the cropping rectangle that was applied to the original image.the value for this key is an nsvalue object containing a cgrect opaque type.available in ios 2.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerMediaURL Specifies the filesystem url for the movie.the value for this key is an nsurl object.available in ios 3.0 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerReferenceURL The assets library url for the original version of the picked item.after the user edits a picked item—such as by cropping an image or trimming a movie—the url continues to point to the original version of the picked item.the value for this key is an nsurl object.available in ios 4.1 and later.declared in uiimagepickercontroller.h.
UIImagePickerControllerMediaMetadata Metadata for a newly-captured photograph.this key is valid only when using an image picker whose source type is set to uiimagepickercontrollersourcetypecamera, and applies only to still images.the value for this key is an nsdictionary object that contains the metadata of the photo that was just captured. to store the metadata along with the image in the camera roll, use the writeimagetosavedphotosalbum:metadata:completionblock: method of the assets library framework.available in ios 4.1 and later.declared in uiimagepickercontroller.h.
UINavigationControllerHideShowBarDuration This variable specifies the duration when animating the navigation bar. note that this is a constant value, so it cannot be set.available in ios 2.0 and later.declared in uinavigationcontroller.h.
UIPageViewControllerNavigationOrientationHorizontal Horizontal orientation, with pages turning left and right.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerNavigationOrientationVertical Vertical orientation, with pages turning up and down.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerNavigationDirectionForward Navigation to the next page.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerNavigationDirectionReverse Navigation to the previous page.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerTransitionStylePageCurl Page curl transition style.when the page curl transition style is specified, the page view controller displays a page-turning animation when transitioning between view controllers. if a data source is specified, the animation follows the user’s finger during a navigation gesture.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerTransitionStyleScroll Scrolling transition style.when the page scrolling style is specified, the page view controller displays a page-scrolling animation when transitioning between view controllers. if a data source is specified, the animation follows the user’s finger during a navigation gesture.available in ios 6.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerOptionSpineLocationKey Location of the spine.for possible values, see “spine locations.” a spine location is only valid if the transition style is uipageviewcontrollertransitionstylepagecurl.if the transition style is uipageviewcontrollertransitionstylepagecurl, the default value for this property is uipageviewcontrollerspinelocationmin; otherwise, the default is uipageviewcontrollerspinelocationnone.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerOptionInterPageSpacingKey Space between pages, in points.the value should be a cgfloat wrapped in an instance of nsnumber. the default value is zero. an inter-page spacing is only valid if the transition style is uipageviewcontrollertransitionstylescroll.available in ios 6.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerSpineLocationNone No spine.this spine location is not valid if the transition style is uipageviewcontrollertransitionstylepagecurl.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerSpineLocationMin Spine at the left or top edge of the screen.one view controller is displayed at a time.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerSpineLocationMid Spine in the middle or the screen.two view controllers are displayed at a time.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPageViewControllerSpineLocationMax Spine at the right or bottom edge of the screen.one view controller is displayed at a time.available in ios 5.0 and later.declared in uipageviewcontroller.h.
UIPasteboardNameGeneral The name identifying the general pasteboard, which is used for general copy-cut-paste operations.available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardNameFind The name identifying the find pasteboard, which is used in search operations. in such operations, the most recent search string in the search bar is put in the find pasteboard.available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardTypeListString An array of pasteboard-item representation types for strings, including kuttypeutf8plaintext. related properties are string and strings.available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardTypeListURL An array of pasteboard-item representation types for urls, including kuttypeurl. related properties are url and urls.available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardTypeListImage An array of pasteboard-item representation types for images, including kuttypepng and kuttypejpeg. related properties are image and images.available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardTypeListColor An array of pasteboard-item representation types for colors. related properties are color and colors.available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardChangedTypesAddedKey With the notification named uipasteboardchangednotification, use this key to access the added representation types. these types are stored as an array in the notification’s userinfo dictionary. available in ios 3.0 and later.declared in uipasteboard.h.
UIPasteboardChangedTypesRemovedKey With the notification named uipasteboardchangednotification, use this key to access the removed representation types. these types are stored as an array in the notification’s userinfo dictionary.available in ios 3.0 and later.declared in uipasteboard.h.
UIPopoverArrowDirectionUp An arrow that points upward.available in ios 3.2 and later.declared in uipopovercontroller.h.
UIPopoverArrowDirectionDown An arrow that points downward.available in ios 3.2 and later.declared in uipopovercontroller.h.
UIPopoverArrowDirectionLeft An arrow that points toward the left.available in ios 3.2 and later.declared in uipopovercontroller.h.
UIPopoverArrowDirectionRight An arrow that points toward the right.available in ios 3.2 and later.declared in uipopovercontroller.h.
UIPopoverArrowDirectionAny An arrow that points in any direction.available in ios 3.2 and later.declared in uipopovercontroller.h.
UIPopoverArrowDirectionUnknown The status of the arrow is currently unknown.available in ios 3.2 and later.declared in uipopovercontroller.h.
UIPrintErrorDomain The string constant defining the uikit printing error domain.available in ios 4.2 and later.declared in uiprinterror.h.
UIPrintingNotAvailableError The device does not support printing.available in ios 4.2 and later.declared in uiprinterror.h.
UIPrintNoContentError No print formatter, page renderer, printing item or printing items was assigned for printing.available in ios 4.2 and later.declared in uiprinterror.h.
UIPrintUnknownImageFormatError An image is in a format not recognized by uikit for printing.available in ios 4.2 and later.declared in uiprinterror.h.
UIPrintJobFailedError An internal error occurred with the print job. available in ios 4.2 and later.declared in uiprinterror.h.
UIScrollViewDecelerationRateNormal The default deceleration rate for a scroll view.available in ios 3.0 and later.declared in uiscrollview.h.
UIScrollViewDecelerationRateFast A fast deceleration rate for a scroll view.available in ios 3.0 and later.declared in uiscrollview.h.
UISegmentedControlNoSegment A segment index value indicating that there is no selected segment. see selectedsegmentindex for further information.available in ios 2.0 and later.declared in uisegmentedcontrol.h.
UITableViewIndexSearch If the data source includes this constant string in the array of strings it returns in sectionindextitlesfortableview:, the section index displays a magnifying glass icon at the corresponding index location. this location should generally be the first title in the index.available in ios 3.0 and later.declared in uitableview.h.
UITableViewAutomaticDimension Requests that uitableview use the default value for a given dimension.available in ios 5.0 and later.declared in uitableview.h.
UITableViewCellSelectionStyleNone The cell has no distinct style for when it is selected.available in ios 2.0 and later.declared in uitableviewcell.h.
UITableViewCellSelectionStyleBlue The cell when selected has a blue background. this is the default value.available in ios 2.0 and later.declared in uitableviewcell.h.
UITableViewCellSelectionStyleGray Then cell when selected has a gray background.available in ios 2.0 and later.declared in uitableviewcell.h.
UITableViewCellSeparatorStyleNone The separator cell has no distinct style.available in ios 2.0 and later.declared in uitableviewcell.h.
UITableViewCellSeparatorStyleSingleLine The separator cell has a single line running across its width. this is the default valueavailable in ios 2.0 and later.declared in uitableviewcell.h.
UITableViewCellSeparatorStyleSingleLineEtched The separator cell has double lines running across its width, giving it an etched look. this style is currently only supported for grouped-style table views.available in ios 3.2 and later.declared in uitableviewcell.h.
UITextInputTextBackgroundColorKey The background color of the text. the value of this key is a uicolor object.available in ios 3.2 and later.declared in uitextinput.h.
UITextInputTextColorKey The color of the text. the value of this key is a uicolor object.available in ios 3.2 and later.declared in uitextinput.h.
UITextInputTextFontKey The font of the text. the value of this key is a uifont object.available in ios 3.2 and later.declared in uitextinput.h.
UITextGranularityCharacter The unit of text is a character.available in ios 3.2 and later.declared in uitextinput.h.
UITextGranularityWord The unit of text is a word.available in ios 3.2 and later.declared in uitextinput.h.
UITextGranularitySentence The unit of text is a sentence.available in ios 3.2 and later.declared in uitextinput.h.
UITextGranularityParagraph The unit of text is a paragraph.available in ios 3.2 and later.declared in uitextinput.h.
UITextGranularityLine The unit of text is a line.available in ios 3.2 and later.declared in uitextinput.h.
UITextGranularityDocument The unit of text is a document.available in ios 3.2 and later.declared in uitextinput.h.
UIViewAnimationOptionLayoutSubviews Lay out subviews at commit time so that they are animated along with their parent.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionAllowUserInteraction Allow the user to interact with views while they are being animated.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionBeginFromCurrentState Start the animation from the current setting associated with an already in-flight animation. if this key is not present, any in-flight animations are allowed to finish before the new animation is started. if another animation is not in flight, this key has no effect. available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionRepeat Repeat the animation indefinitely.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionAutoreverse Run the animation backwards and forwards. must be combined with the uiviewanimationoptionrepeat option.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionOverrideInheritedDuration Force the animation to use the original duration value specified when the animation was submitted. if this key is not present, the animation inherits the remaining duration of the in-flight animation, if any. available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionOverrideInheritedCurve Force the animation to use the original curve value specified when the animation was submitted. if this key is not present, the animation inherits the curve of the in-flight animation, if any. available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionAllowAnimatedContent Animate the views by changing the property values dynamically and redrawing the view. if this key is not present, the views are animated using a snapshot image.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionShowHideTransitionViews When present, this key causes views to be hidden or shown (instead of removed or added) when performing a view transition. both views must already be present in the parent view’s hierarchy when using this key. if this key is not present, the to-view in a transition is added to, and the from-view is removed from, the parent view’s list of subviews. available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionCurveEaseInOut An ease-in ease-out curve causes the animation to begin slowly, accelerate through the middle of its duration, and then slow again before completing.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionCurveEaseIn An ease-in curve causes the animation to begin slowly, and then speed up as it progresses.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionCurveEaseOut An ease-out curve causes the animation to begin quickly, and then slow as it completes.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionCurveLinear A linear animation curve causes an animation to occur evenly over its duration.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionNone No transition is specified.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionFlipFromLeft A transition that flips a view around its vertical axis from left to right. the left side of the view moves toward the front and right side toward the back.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionFlipFromRight A transition that flips a view around its vertical axis from right to left. the right side of the view moves toward the front and left side toward the back.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionCurlUp A transition that curls a view up from the bottom.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionCurlDown A transition that curls a view down from the top.available in ios 4.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionCrossDissolve A transition that dissolves from one view to the next.available in ios 5.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionFlipFromTop A transition that flips a view around its horizontal axis from top to bottom. the top side of the view moves toward the front and the bottom side toward the back. available in ios 5.0 and later.declared in uiview.h.
UIViewAnimationOptionTransitionFlipFromBottom A transition that flips a view around its horizontal axis from bottom to top. the bottom side of the view moves toward the front and the top side toward the back.available in ios 5.0 and later.declared in uiview.h.
UILayoutConstraintAxisHorizontal The constraint is applied when laying out the horizontal relationship between objects.available in ios 6.0 and later.declared in uiview.h.
UILayoutConstraintAxisVertical The constraint is applied when laying out the vertical relationship between objects.available in ios 6.0 and later.declared in uiview.h.
UILayoutFittingCompressedSize Indicates that you want the smallest possible size.available in ios 6.0 and later.declared in uiview.h.
UILayoutFittingExpandedSize Indicates that you want the largest possible size.available in ios 6.0 and later.declared in uiview.h.
UIViewNoIntrinsicMetric Used to indicate that a view has no intrinsic metric for a given numeric property.available in ios 6.0 and later.declared in uiview.h.
UIViewAutoresizingNone The view does not resize.available in ios 2.0 and later.declared in uiview.h.
UIViewAutoresizingFlexibleLeftMargin The view resizes by expanding or shrinking in the direction of the left margin.available in ios 2.0 and later.declared in uiview.h.
UIViewAutoresizingFlexibleWidth The view resizes by expanding or shrinking its width.available in ios 2.0 and later.declared in uiview.h.
UIViewAutoresizingFlexibleRightMargin The view resizes by expanding or shrinking in the direction of the right margin.available in ios 2.0 and later.declared in uiview.h.
UIViewAutoresizingFlexibleTopMargin The view resizes by expanding or shrinking in the direction of the top margin.available in ios 2.0 and later.declared in uiview.h.
UIViewAutoresizingFlexibleHeight The view resizes by expanding or shrinking its height.available in ios 2.0 and later.declared in uiview.h.
UIViewAutoresizingFlexibleBottomMargin The view resizes by expanding or shrinking in the direction of the bottom margin.available in ios 2.0 and later.declared in uiview.h.
UIViewControllerHierarchyInconsistencyException Raised if the view controller hierarchy is inconsistent with the view hierarchy.when a view controller’s view is added to the view hierarchy, the system walks up the view hierarchy to find the first parent view that has a view controller. that view controller must be the parent of the view controller whose view is being added. otherwise, this exception is raised. this consistency check is also performed when a view controller is added as a child by calling the addchildviewcontroller: method.it is also allowed for a view controller that has no parent to add its view to the view hierarchy. this is generally not recommended, but is useful in some special cases.available in ios 5.0 and later.declared in uiviewcontroller.h.
UIStateRestorationViewControllerStoryboardKey The value of this key is a uistoryboard object representing the storyboard from which the view controller was initially obtained. normally, you do not need to write this key to the coder yourself. the uiviewcontroller class automatically writes this key to the coder during the state preservation process.available in ios 6.0 and later.declared in uistaterestoration.h.
UIWebViewNavigationTypeLinkClicked User tapped a link.available in ios 2.0 and later.declared in uiwebview.h.
UIWebViewNavigationTypeFormSubmitted User submitted a form.available in ios 2.0 and later.declared in uiwebview.h.
UIWebViewNavigationTypeBackForward User tapped the back or forward button.available in ios 2.0 and later.declared in uiwebview.h.
UIWebViewNavigationTypeReload User tapped the reload button.available in ios 2.0 and later.declared in uiwebview.h.
UIWebViewNavigationTypeFormResubmitted User resubmitted a form.available in ios 2.0 and later.declared in uiwebview.h.
UIWebViewNavigationTypeOther Some other action occurred.available in ios 2.0 and later.declared in uiwebview.h.
AVURLAssetPreferPreciseDurationAndTimingKey The corresponding value is a boolean, contained in an nsvalue object, that indicates whether the asset should be prepared to indicate a precise duration and provide precise random access by time.yes indicates that longer loading times are acceptable in cases in which precise timing is required. such precision, however, may require additional parsing of the resource in advance of operations that make use of any portion of it, depending on the specifics of its container format.many container formats provide sufficient summary information for precise timing and do not require additional parsing to prepare for it; quicktime movie files and mpeg-4 files are examples of such formats. other formats do not provide sufficient summary information, and precise random access for them is possible only after a preliminary examination of a file's contents.if you only intend that the asset be played, the default value of no will suffice (because avplayer supports approximate random access by time when full precision isn't available). if you intend to insert the asset into an avmutablecomposition object, precise random access is typically desirable, and the value of yes is recommended.available in ios 4.0 and later.declared in avasset.h.
AVURLAssetReferenceRestrictionsKey The corresponding value is a an nsnumber wrapping an “avassetreferencerestrictions” enum value or the logical combination of multiple such values indicating the restrictions used by the asset when resolving references to external media data.some assets can contain references to media data stored outside the asset’s container file, for example in another file. you can use this key to specify a policy to use when these references are encountered. if an asset contains one or more references of a type that is forbidden by the reference restrictions, loading of asset properties will fail. in addition, such an asset cannot be used with other avfoundation objects, such as avplayeritem or avassetexportsession.available in ios 5.0 and later.declared in avasset.h.
AVAssetReferenceRestrictionForbidNone Indicates that all types of references should be followed.available in ios 5.0 and later.declared in avasset.h.
AVAssetReferenceRestrictionForbidRemoteReferenceToLocal Indicates that references from a remote asset (for example, referenced via http url) to local media data (for example, stored in a local file) should not be followed.available in ios 5.0 and later.declared in avasset.h.
AVAssetReferenceRestrictionForbidLocalReferenceToRemote Indicates that references from a local asset to remote media data should not be followed.available in ios 5.0 and later.declared in avasset.h.
AVAssetReferenceRestrictionForbidCrossSiteReference Indicates that references from a remote asset to remote media data stored at a different site should not be followed.available in ios 5.0 and later.declared in avasset.h.
AVAssetReferenceRestrictionForbidLocalReferenceToLocal Indicates that references from a local asset to local media data stored outside the asset’s container file should not be followed.available in ios 5.0 and later.declared in avasset.h.
AVAssetReferenceRestrictionForbidAll Indicates that only references to media data stored within the asset’s container file should be allowed.available in ios 5.0 and later.declared in avasset.h.
UIWindowLevelNormal The default level.available in ios 2.0 and later.declared in uiwindow.h.
UIWindowLevelAlert The level for an alert view.available in ios 2.0 and later.declared in uiwindow.h.
UIWindowLevelStatusBar The level for a status window.available in ios 2.0 and later.declared in uiwindow.h.
UIKeyboardFrameBeginUserInfoKey The key for an nsvalue object containing a cgrect that identifies the start frame of the keyboard in screen coordinates. these coordinates do not take into account any rotation factors applied to the window’s contents as a result of interface orientation changes. thus, you may need to convert the rectangle to window coordinates (using the convertrect:fromwindow: method) or to view coordinates (using the convertrect:fromview: method) before using it. available in ios 3.2 and later.declared in uiwindow.h.
UIKeyboardFrameEndUserInfoKey The key for an nsvalue object containing a cgrect that identifies the end frame of the keyboard in screen coordinates. these coordinates do not take into account any rotation factors applied to the window’s contents as a result of interface orientation changes. thus, you may need to convert the rectangle to window coordinates (using the convertrect:fromwindow: method) or to view coordinates (using the convertrect:fromview: method) before using it. available in ios 3.2 and later.declared in uiwindow.h.
UIKeyboardAnimationCurveUserInfoKey The key for an nsnumber object containing a uiviewanimationcurve constant that defines how the keyboard will be animated onto or off the screen.available in ios 3.0 and later.declared in uiwindow.h.
UIKeyboardAnimationDurationUserInfoKey The key for an nsnumber object containing a double that identifies the duration of the animation in seconds.available in ios 3.0 and later.declared in uiwindow.h.
UIKeyboardCenterBeginUserInfoKey The key for an nsvalue object containing a cgpoint that is the center of the keyboard in window coordinates before animation. these coordinates actually take into account any rotation factors applied to the window’s contents as a result of interface orientation changes. thus, the center point of the keyboard is different in portrait versus landscape orientations. use the uikeyboardframebeginuserinfokey key instead.available in ios 2.0 and later.deprecated in ios 3.2.declared in uiwindow.h.
UIKeyboardCenterEndUserInfoKey The key for an nsvalue object containing a cgpoint that is the center of the keyboard in window coordinates after animation. these coordinates take into account any rotation factors applied to the window’s contents as a result of interface orientation changes. thus, the center point of the keyboard is different in portrait versus landscape orientations.use the uikeyboardframeenduserinfokey key instead.available in ios 2.0 and later.deprecated in ios 3.2.declared in uiwindow.h.
UIKeyboardBoundsUserInfoKey The key for an nsvalue object containing a cgrect that identifies the bounds rectangle of the keyboard in window coordinates. this value is sufficient for obtaining the size of the keyboard. if you want to get the origin of the keyboard on the screen (before or after animation) use the values obtained from the user info dictionary through the uikeyboardcenterbeginuserinfokey or uikeyboardcenterenduserinfokey constants.use the uikeyboardframebeginuserinfokey or uikeyboardframeenduserinfokey key instead.available in ios 2.0 and later.deprecated in ios 3.2.declared in uiwindow.h.
ADBannerContentSizeIdentifier320x50 Indicates that the banner view is 320 points by 50 points in size. this size is used on iphone for portrait advertisements. (deprecated. use adbannercontentsizeidentifierportrait instead.)available in ios 4.0 and later.deprecated in ios 4.2.declared in adbannerview_deprecated.h.
ADBannerContentSizeIdentifier480x32 Indicates that the banner view is 480 points by 32 points in size. this size is used on iphone for landscape advertisements. (deprecated. use adbannercontentsizeidentifierlandscape instead.)available in ios 4.0 and later.deprecated in ios 4.2.declared in adbannerview_deprecated.h.
ADBannerContentSizeIdentifierPortrait Indicates that the banner view is in portait mode. the exact size of the portait view is dependent on the ios device the advertisement is displayed on. on iphone, a portrait banner is 320 points by 50 points in size. on ipad, a portrait banner is 768 points by 66 points in size.available in ios 4.2 and later.deprecated in ios 6.0.declared in adbannerview_deprecated.h.
ADBannerContentSizeIdentifierLandscape Indicates that the banner view is in landscape mode. the exact size of the view is dependent on the ios device the advertisement is displayed on. on iphone, a landscape banner is 480 points by 32 points in size. on ipad, a landscape banner is 1024 points by 66 points in size.available in ios 4.2 and later.deprecated in ios 6.0.declared in adbannerview_deprecated.h.
ADErrorDomain Indicates an error occurred in iad.available in ios 4.0 and later.declared in adbannerview.h.
ADErrorUnknown Indicates that an unknown or unexpected error occurred.available in ios 4.0 and later.declared in adbannerview.h.
ADErrorServerFailure Indicates that the connection to the advertisements server failed.available in ios 4.0 and later.declared in adbannerview.h.
ADErrorLoadingThrottled Indicates that the download from the advertisements server is currently being throttled.available in ios 4.0 and later.declared in adbannerview.h.
ADErrorInventoryUnavailable Indicates that no advertisements are currently available to download.available in ios 4.0 and later.declared in adbannerview.h.
ADErrorConfigurationError Indicates that your application has not been configured to receive advertisements. check your application’s configuration on itunes connect. this error is not received when your application is running in sandbox.available in ios 4.1 and later.declared in adbannerview.h.
ADErrorBannerVisibleWithoutContent Indicates that the banner is visible, but no advertisement is shown. your application must always hide the banner when it does not have an advertisement to display.available in ios 4.1 and later.declared in adbannerview.h.
ADErrorApplicationInactive Indicates that ad content is not available because the application is not currently active.available in ios 4.3 and later.declared in adbannerview.h.
NSFileWrapperReadingImmediate If reading with this option succeeds, then subsequent invocations of filewrappers, regularfilecontents, symboliclinkdestinationurl, and serializedrepresentation sent to the file wrapper and all its child file wrappers will fail and return nil only if an actual error occurs (for example, the volume has disappeared or the file server is unreachable)—not as a result of the user moving or deleting files. for performance reasons, nsfilewrapper may not read the contents of some file packages immediately even when this option is chosen. for example, because the contents of bundles (not all file packages are bundles) are immutable to the user, nsfilewrapper may read the children of such a directory lazily. you can use this option to take a snapshot of a file or folder for writing later. for example, an application like textedit can use this option when creating new file wrappers to represent attachments that the user creates by copying and pasting or dragging and dropping from the finder to a textedit document. don’t use this option when reading a document file package, because that would cause unnecessarily bad performance. for example, an application wouldn’t use this option when creating file wrappers to represent attachments as it’s opening a document stored in a file package.available in ios 4.0 and later.declared in nsfilewrapper.h.
NSFileWrapperReadingWithoutMapping Whether file mapping for regular file wrappers is disallowed.you can use this option to keep nsfilewrapper from memory-mapping files. this is useful if you want to make sure your application doesn't hold files open (mapped files are open files), therefore preventing the user from ejecting dvds, unmounting disk partitions, or unmounting disk images. in mac os x v10.6 and later, nsfilewrapper memory-maps files that are on internal drives only. it never memory-maps files on external drives or network volumes, regardless of whether this option is used. available in ios 4.0 and later.declared in nsfilewrapper.h.
NSFileWrapperWritingAtomic Whether writing is done atomically.you can use this option to ensure that, when overwriting a file package, the overwriting either completely succeeds or completely fails, with no possibility of leaving the file package in an inconsistent state. because this option causes additional i/o, you shouldn't use it unnecessarily. for example, don't use this option in an override of -[nsdocument writetourl:oftype:error:], because nsdocument safe-saving is already done atomically.available in ios 4.0 and later.declared in nsfilewrapper.h.
NSFileWrapperWritingWithNameUpdating Whether descendant file wrappers are sent the setfilename: method if the writing succeeds.this option is necessary when your application passes a url in the originalcontentsurl parameter to the writetourl:options:originalcontentsurl:error: method. without using this option (and reusing child file wrappers properly), subsequent invocations of writetourl:options:originalcontentsurl:error: would not be able to reliably create hard links in a new file package, because the record of names in the old file package would be out of date.available in ios 4.0 and later.declared in nsfilewrapper.h.

Instance Method Summary (collapse)

- AVMakeRectWithAspectRatioInsideRect:

Returns a scaled CGRect that maintains the aspect ratio specified by a CGSize within a bounding CGRect.
- CACurrentMediaTime

Returns the current absolute time, in seconds.
- CATransform3DConcat:

Concatenate 'b' to 'a' and return the result: t' = a * b.
- CATransform3DEqualToTransform:

Returns a Boolean value that indicates whether the two transforms are exactly equal.
- CATransform3DGetAffineTransform:

Returns the affine transform represented by 't'.
- CATransform3DInvert:

Invert 't' and return the result.
- CATransform3DIsAffine:

Returns true if 't' can be exactly represented by an affine transform.
- CATransform3DIsIdentity:

Returns a Boolean value that indicates whether the transform is the identity transform.
- CATransform3DMakeRotation:

Returns a transform that rotates by 'angle' radians about the vector '(x, y, z)'.
- CATransform3DMakeScale:

Returns a transform that scales by `(sx, sy, sz)': * t' = [sx 0 0 0; 0 sy 0 0; 0 0 sz 0; 0 0 0 1].
- CATransform3DTranslate:

Translate 't' by '(tx, ty, tz)' and return the result: t' = translate(tx, ty, tz) * t.
- CFAbsoluteTimeAddGregorianUnits:

Adds a time interval, expressed as Gregorian units, to a given absolute time.
- CFAbsoluteTimeGetDayOfWeek:

Returns an integer representing the day of the week indicated by the specified absolute time.
- CFAbsoluteTimeGetDayOfYear:

Returns an integer representing the day of the year indicated by the specified absolute time.
- CFAbsoluteTimeGetDifferenceAsGregorianUnits:

Computes the time difference between two specified absolute times and returns the result as an interval in Gregorian units.
- CFAbsoluteTimeGetGregorianDate:

Converts an absolute time value into a Gregorian date.
- CFAbsoluteTimeGetWeekOfYear:

Returns an integer representing the week of the year indicated by the specified absolute time.
- CFAllocatorAllocate:

Allocates memory using the specified allocator.
- CFAllocatorCreate:

Creates an allocator object.
- CFAllocatorDeallocate:

Deallocates a block of memory with a given allocator.
- CFAllocatorGetContext:

Obtains the context of the specified allocator or of the default allocator.
- CFAllocatorGetDefault

Gets the default allocator object for the current thread.
- CFAllocatorGetPreferredSizeForSize:

Obtains the number of bytes likely to be allocated upon a specific request.
- CFAllocatorGetTypeID

Returns the type identifier for the CFAllocator opaque type.
- CFAllocatorReallocate:

Reallocates memory using the specified allocator.
- CFAllocatorSetDefault:

Sets the given allocator as the default for the current thread.
- CFArrayAppendArray:

Adds the values from one array to another array.
- CFArrayAppendValue:

Adds a value to an array giving it the new largest index.
- CFArrayApplyFunction:

Calls a function once for each element in range in an array.
- CFArrayBSearchValues:

Searches an array for a value using a binary search algorithm.
- CFArrayContainsValue:

Reports whether or not a value is in an array.
- CFArrayCreate:

Creates a new immutable array with the given values.
- CFArrayCreateCopy:

Creates a new immutable array with the values from another array.
- CFArrayCreateMutable:

Creates a new empty mutable array.
- CFArrayCreateMutableCopy:

Creates a new mutable array with the values from another array.
- CFArrayExchangeValuesAtIndices:

Exchanges the values at two indices of an array.
- CFArrayGetCount:

Returns the number of values currently in an array.
- CFArrayGetCountOfValue:

Counts the number of times a given value occurs in an array.
- CFArrayGetFirstIndexOfValue:

Searches an array forward for a value.
- CFArrayGetLastIndexOfValue:

Searches an array backward for a value.
- CFArrayGetTypeID

Returns the type identifier for the CFArray opaque type.
- CFArrayGetValueAtIndex:

Retrieves a value at a given index.
- CFArrayGetValues:

Fills a buffer with values from an array.
- CFArrayInsertValueAtIndex:

Inserts a value into an array at a given index.
- CFArrayRemoveAllValues:

Removes all the values from an array, making it empty.
- CFArrayRemoveValueAtIndex:

Removes the value at a given index from an array.
- CFArrayReplaceValues:

Replaces a range of values in an array.
- CFArraySetValueAtIndex:

Changes the value at a given index in an array.
- CFArraySortValues:

Sorts the values in an array using a given comparison function.
- CFAttributedStringBeginEditing:

Defers internal consistency-checking and coalescing for a mutable attributed string.
- CFAttributedStringCreate:

Creates an attributed string with specified string and attributes.
- CFAttributedStringCreateCopy:

Creates an immutable copy of an attributed string.
- CFAttributedStringCreateMutable:

Creates a mutable attributed string.
- CFAttributedStringCreateMutableCopy:

Creates a mutable copy of an attributed string.
- CFAttributedStringCreateWithSubstring:

Creates a sub-attributed string from the specified range.
- CFAttributedStringEndEditing:

Re-enables internal consistency-checking and coalescing for a mutable attributed string.
- CFAttributedStringGetAttribute:

Returns the value of a given attribute of an attributed string at a specified location.
- CFAttributedStringGetAttributeAndLongestEffectiveRange:

Returns the value of a given attribute of an attributed string at a specified location.
- CFAttributedStringGetAttributes:

Returns the attributes of an attributed string at a specified location.
- CFAttributedStringGetAttributesAndLongestEffectiveRange:

Returns the attributes of an attributed string at a specified location.
- CFAttributedStringGetLength:

Returns the length of the attributed string in characters.
- CFAttributedStringGetMutableString:

Gets as a mutable string the string for an attributed string.
- CFAttributedStringGetString:

Returns the string for an attributed string.
- CFAttributedStringGetTypeID

Returns the type identifier for the CFAttributedString opaque type.
- CFAttributedStringRemoveAttribute:

Removes the value of a single attribute over a specified range.
- CFAttributedStringReplaceAttributedString:

Replaces the attributed substring over a range with another attributed string.
- CFAttributedStringReplaceString:

Modifies the string of an attributed string.
- CFAttributedStringSetAttribute:

Sets the value of a single attribute over the specified range.
- CFAttributedStringSetAttributes:

Sets the value of attributes of a mutable attributed string over a specified range.
- CFBagAddValue:

Adds a value to a mutable bag.
- CFBagApplyFunction:

Calls a function once for each value in a bag.
- CFBagContainsValue:

Reports whether or not a value is in a bag.
- CFBagCreate:

Creates an immutable bag containing specified values.
- CFBagCreateCopy:

Creates an immutable bag with the values of another bag.
- CFBagCreateMutable:

Creates a new empty mutable bag.
- CFBagCreateMutableCopy:

Creates a new mutable bag with the values from another bag.
- CFBagGetCount:

Returns the number of values currently in a bag.
- CFBagGetCountOfValue:

Returns the number of times a value occurs in a bag.
- CFBagGetTypeID

Returns the type identifier for the CFBag opaque type.
- CFBagGetValue:

Returns a requested value from a bag.
- CFBagGetValueIfPresent:

Reports whether or not a value is in a bag, and returns that value indirectly if it exists.
- CFBagGetValues:

Fills a buffer with values from a bag.
- CFBagRemoveAllValues:

Removes all values from a mutable bag.
- CFBagRemoveValue:

Removes a value from a mutable bag.
- CFBagReplaceValue:

Replaces a value in a mutable bag.
- CFBagSetValue:

Sets a value in a mutable bag.
- CFBinaryHeapAddValue:

Adds a value to a binary heap.
- CFBinaryHeapApplyFunction:

Iteratively applies a function to all the values in a binary heap.
- CFBinaryHeapContainsValue:

Returns whether a given value is in a binary heap.
- CFBinaryHeapCreate:

Creates a new mutable or fixed-mutable binary heap.
- CFBinaryHeapCreateCopy:

Creates a new mutable or fixed-mutable binary heap with the values from a pre-existing binary heap.
- CFBinaryHeapGetCount:

Returns the number of values currently in a binary heap.
- CFBinaryHeapGetCountOfValue:

Counts the number of times a given value occurs in a binary heap.
- CFBinaryHeapGetMinimum:

Returns the minimum value in a binary heap.
- CFBinaryHeapGetMinimumIfPresent:

Returns the minimum value in a binary heap, if present.
- CFBinaryHeapGetTypeID

Returns the type identifier of the CFBinaryHeap opaque type.
- CFBinaryHeapGetValues:

Copies all the values from a binary heap into a sorted C array.
- CFBinaryHeapRemoveAllValues:

Removes all values from a binary heap, making it empty.
- CFBinaryHeapRemoveMinimumValue:

Removes the minimum value from a binary heap.
- CFBitVectorContainsBit:

Returns whether a bit vector contains a particular bit value.
- CFBitVectorCreate:

Creates an immutable bit vector from a block of memory.
- CFBitVectorCreateCopy:

Creates an immutable bit vector that is a copy of another bit vector.
- CFBitVectorCreateMutable:

Creates a mutable bit vector.
- CFBitVectorCreateMutableCopy:

Creates a new mutable bit vector from a pre-existing bit vector.
- CFBitVectorFlipBitAtIndex:

Flips a bit value in a bit vector.
- CFBitVectorFlipBits:

Flips a range of bit values in a bit vector.
- CFBitVectorGetBitAtIndex:

Returns the bit value at a given index in a bit vector.
- CFBitVectorGetBits:

Returns the bit values in a range of indices in a bit vector.
- CFBitVectorGetCount:

Returns the number of bit values in a bit vector.
- CFBitVectorGetCountOfBit:

Counts the number of times a certain bit value occurs within a range of bits in a bit vector.
- CFBitVectorGetFirstIndexOfBit:

Locates the first occurrence of a certain bit value within a range of bits in a bit vector.
- CFBitVectorGetLastIndexOfBit:

Locates the last occurrence of a certain bit value within a range of bits in a bit vector.
- CFBitVectorGetTypeID

Returns the type identifier for the CFBitVector opaque type.
- CFBitVectorSetAllBits:

Sets all bits in a bit vector to a particular value.
- CFBitVectorSetBitAtIndex:

Sets the value of a particular bit in a bit vector.
- CFBitVectorSetBits:

Sets a range of bits in a bit vector to a particular value.
- CFBitVectorSetCount:

Changes the size of a mutable bit vector.
- CFBooleanGetTypeID

Returns the Core Foundation type identifier for the CFBoolean opaque type.
- CFBooleanGetValue:

Returns the value of a CFBoolean object as a standard C type Boolean.
- CFBundleCloseBundleResourceMap:

Closes an open resource map for a bundle.
- CFBundleCopyAuxiliaryExecutableURL:

Returns the location of a bundle’s auxiliary executable code.
- CFBundleCopyBuiltInPlugInsURL:

Returns the location of a bundle’s built in plug-in.
- CFBundleCopyBundleLocalizations:

Returns an array containing a bundle’s localizations.
- CFBundleCopyBundleURL:

Returns the location of a bundle.
- CFBundleCopyExecutableArchitectures:

Returns an array of CFNumbers representing the architectures a given bundle provides.
- CFBundleCopyExecutableArchitecturesForURL:

Returns an array of CFNumbers representing the architectures a given URL provides.
- CFBundleCopyExecutableURL:

Returns the location of a bundle’s main executable code.
- CFBundleCopyInfoDictionaryForURL:

Returns the information dictionary for a given URL location.
- CFBundleCopyInfoDictionaryInDirectory:

Returns a bundle’s information dictionary.
- CFBundleCopyLocalizationsForPreferences:

Given an array of possible localizations and preferred locations, returns the one or more of them that CFBundle would use, without reference to the current application context.
- CFBundleCopyLocalizationsForURL:

Returns an array containing the localizations for a bundle or executable at a particular location.
- CFBundleCopyLocalizedString:

Returns a localized string from a bundle’s strings file.
- CFBundleCopyPreferredLocalizationsFromArray:

Given an array of possible localizations, returns the one or more of them that CFBundle would use in the current application context.
- CFBundleCopyPrivateFrameworksURL:

Returns the location of a bundle’s private Frameworks directory.
- CFBundleCopyResourcesDirectoryURL:

Returns the location of a bundle’s Resources directory.
- CFBundleCopyResourceURL:

Returns the location of a resource contained in the specified bundle.
- CFBundleCopyResourceURLForLocalization:

Returns the location of a localized resource in a bundle.
- CFBundleCopyResourceURLInDirectory:

Returns the location of a resource contained in the specified bundle directory without requiring the creation of a CFBundle object.
- CFBundleCopyResourceURLsOfType:

Assembles an array of URLs specifying all of the resources of the specified type found in a bundle.
- CFBundleCopyResourceURLsOfTypeForLocalization:

Returns an array containing copies of the URL locations for a specified bundle, resource, and localization name.
- CFBundleCopyResourceURLsOfTypeInDirectory:

Returns an array of CFURL objects describing the locations of all resources in a bundle of the specified type without needing to create a CFBundle object.
- CFBundleCopySharedFrameworksURL:

Returns the location of a bundle’s shared frameworks directory.
- CFBundleCopySharedSupportURL:

Returns the location of a bundle’s shared support files directory.
- CFBundleCopySupportFilesDirectoryURL:

Returns the location of the bundle’s support files directory.
- CFBundleCreate:

Creates a CFBundle object.
- CFBundleCreateBundlesFromDirectory:

Searches a directory and constructs an array of CFBundle objects from all valid bundles in the specified directory.
- CFBundleGetAllBundles

Returns an array containing all of the bundles currently open in the application.
- CFBundleGetBundleWithIdentifier:

Locate a bundle given its program-defined identifier.
- CFBundleGetDataPointerForName:

Returns a data pointer to a symbol of the given name.
- CFBundleGetDataPointersForNames:

Returns a C array of data pointer to symbols of the given names.
- CFBundleGetDevelopmentRegion:

Returns the bundle’s development region from the bundle’s information property list.
- CFBundleGetFunctionPointerForName:

Returns a pointer to a function in a bundle’s executable code using the function name as the search key.
- CFBundleGetFunctionPointersForNames:

Constructs a function table containing pointers to all of the functions found in a bundle’s main executable code.
- CFBundleGetIdentifier:

Returns the bundle identifier from a bundle’s information property list.
- CFBundleGetInfoDictionary:

Returns a bundle’s information dictionary.
- CFBundleGetLocalInfoDictionary:

Returns a bundle’s localized information dictionary.
- CFBundleGetMainBundle

Returns an application’s main bundle.
- CFBundleGetPackageInfo:

Returns a bundle’s package type and creator.
- CFBundleGetPackageInfoInDirectory:

Returns a bundle’s package type and creator without having to create a CFBundle object.
- CFBundleGetPlugIn:

Returns a bundle’s plug-in.
- CFBundleGetTypeID

Returns the type identifier for the CFBundle opaque type.
- CFBundleGetValueForInfoDictionaryKey:

Returns a value (localized if possible) from a bundle’s information dictionary.
- CFBundleGetVersionNumber:

Returns a bundle’s version number.
- CFBundleIsExecutableLoaded:

Obtains information about the load status for a bundle’s main executable.
- CFBundleLoadExecutable:

Loads a bundle’s main executable code into memory and dynamically links it into the running application.
- CFBundleLoadExecutableAndReturnError:

Returns a Boolean value that indicates whether a given bundle is loaded, attempting to load it if necessary.
- CFBundleOpenBundleResourceFiles:

Opens the non-localized and localized resource files (if any) for a bundle in separate resource maps.
- CFBundleOpenBundleResourceMap:

Opens the non-localized and localized resource files (if any) for a bundle in a single resource map.
- CFBundlePreflightExecutable:

Returns a Boolean value that indicates whether a given bundle is loaded or appears to be loadable.
- CFBundleUnloadExecutable:

Unloads the main executable for the specified bundle.
- CFByteOrderGetCurrent

Returns the byte order of the current computer.
- CFCalendarAddComponents:

Computes the absolute time when specified components are added to a given absolute time.
- CFCalendarComposeAbsoluteTime:

Computes the absolute time from components in a description string.
- CFCalendarCopyCurrent

Returns a copy of the logical calendar for the current user.
- CFCalendarCopyLocale:

Returns a locale object for a specified calendar.
- CFCalendarCopyTimeZone:

Returns a time zone object for a specified calendar.
- CFCalendarCreateWithIdentifier:

Returns a calendar object for the calendar identified by a calendar identifier.
- CFCalendarDecomposeAbsoluteTime:

Computes the components which are indicated by the componentDesc description string for the given absolute time.
- CFCalendarGetComponentDifference:

Computes the difference between the two absolute times, in terms of specified calendrical components.
- CFCalendarGetFirstWeekday:

Returns the index of first weekday for a specified calendar.
- CFCalendarGetIdentifier:

Returns the given calendar’s identifier.
- CFCalendarGetMaximumRangeOfUnit:

Returns the maximum range limits of the values that a specified unit can take on in a given calendar.
- CFCalendarGetMinimumDaysInFirstWeek:

Returns the minimum number of days in the first week of a specified calendar.
- CFCalendarGetMinimumRangeOfUnit:

Returns the minimum range limits of the values that a specified unit can take on in a given calendar.
- CFCalendarGetOrdinalityOfUnit:

Returns the ordinal number of a calendrical unit within a larger unit at a specified absolute time.
- CFCalendarGetRangeOfUnit:

Returns the range of values that one unit can take on within a larger unit during which a specific absolute time occurs.
- CFCalendarGetTimeRangeOfUnit:

Returns by reference the start time and duration of a given calendar unit that contains a given absolute time.
- CFCalendarGetTypeID

Returns the type identifier for the CFCalendar opaque type.
- CFCalendarSetFirstWeekday:

Sets the first weekday for a calendar.
- CFCalendarSetLocale:

Sets the locale for a calendar.
- CFCalendarSetMinimumDaysInFirstWeek:

Sets the minimum number of days in the first week of a specified calendar.
- CFCalendarSetTimeZone:

Sets the time zone for a calendar.
- CFCharacterSetAddCharactersInRange:

Adds a given range to a character set.
- CFCharacterSetAddCharactersInString:

Adds the characters in a given string to a character set.
- CFCharacterSetCreateBitmapRepresentation:

Creates a new immutable data with the bitmap representation from the given character set.
- CFCharacterSetCreateCopy:

Creates a new character set with the values from a given character set.
- CFCharacterSetCreateInvertedSet:

Creates a new immutable character set that is the invert of the specified character set.
- CFCharacterSetCreateMutable:

Creates a new empty mutable character set.
- CFCharacterSetCreateMutableCopy:

Creates a new mutable character set with the values from another character set.
- CFCharacterSetCreateWithBitmapRepresentation:

Creates a new immutable character set with the bitmap representation specified by given data.
- CFCharacterSetCreateWithCharactersInRange:

Creates a new character set with the values from the given range of Unicode characters.
- CFCharacterSetCreateWithCharactersInString:

Creates a new character set with the values in the given string.
- CFCharacterSetGetPredefined:

Returns a predefined character set.
- CFCharacterSetGetTypeID

Returns the type identifier of the CFCharacterSet opaque type.
- CFCharacterSetHasMemberInPlane:

Reports whether or not a character set contains at least one member character in the specified plane.
- CFCharacterSetIntersect:

Forms an intersection of two character sets.
- CFCharacterSetInvert:

Inverts the content of a given character set.
- CFCharacterSetIsCharacterMember:

Reports whether or not a given Unicode character is in a character set.
- CFCharacterSetIsLongCharacterMember:

Reports whether or not a given UTF-32 character is in a character set.
- CFCharacterSetIsSupersetOfSet:

Reports whether or not a character set is a superset of another set.
- CFCharacterSetRemoveCharactersInRange:

Removes a given range of Unicode characters from a character set.
- CFCharacterSetRemoveCharactersInString:

Removes the characters in a given string from a character set.
- CFCharacterSetUnion:

Forms the union of two character sets.
- CFConvertDoubleHostToSwapped:

Converts a 64-bit double from the host’s native byte order to a platform-independent format.
- CFConvertDoubleSwappedToHost:

Converts a 64-bit double from a platform-independent format to the host’s native byte order.
- CFConvertFloat32HostToSwapped:

Converts a 32-bit float from the host’s native byte order to a platform-independent format.
- CFConvertFloat32SwappedToHost:

Converts a 32-bit float from a platform-independent format to the host’s native byte order.
- CFConvertFloat64HostToSwapped:

Converts a 64-bit float from the host’s native byte order to a platform-independent format.
- CFConvertFloat64SwappedToHost:

Converts a 64-bit float from a platform-independent format to the host’s native byte order.
- CFConvertFloatHostToSwapped:

Converts a 32-bit float from the host’s native byte order to a platform-independent format.
- CFConvertFloatSwappedToHost:

Converts a 32-bit float from a platform-independent format to the host’s native byte order.
- CFCopyDescription:

Returns a textual description of a Core Foundation object.
- CFCopyLocalizedString:

Searches the default strings file Localizable.strings for the string associated with the specified key.
- CFCopyLocalizedStringFromTable:

Searches the specified strings file for the string associated with the specified key.
- CFCopyLocalizedStringFromTableInBundle:

Returns a localized version of the specified string.
- CFCopyLocalizedStringWithDefaultValue:

Returns a localized version of a localization string.
- CFCopyTypeIDDescription:

Returns a textual description of a Core Foundation type, as identified by its type ID, which can be used when debugging.
- CFDataAppendBytes:

Appends the bytes from a byte buffer to the contents of a CFData object.
- CFDataCreate:

Creates an immutable CFData object using data copied from a specified byte buffer.
- CFDataCreateCopy:

Creates an immutable copy of a CFData object.
- CFDataCreateMutable:

Creates an empty CFMutableData object.
- CFDataCreateMutableCopy:

Creates a CFMutableData object by copying another CFData object.
- CFDataCreateWithBytesNoCopy:

Creates an immutable CFData object from an external (client-owned) byte buffer.
- CFDataDeleteBytes:

Deletes the bytes in a CFMutableData object within a specified range.
- CFDataFind:

Finds and returns the range within a data object of the first occurrence of the given data, within a given range, subject to any given options.
- CFDataGetBytePtr:

Returns a read-only pointer to the bytes of a CFData object.
- CFDataGetBytes:

Copies the byte contents of a CFData object to an external buffer.
- CFDataGetLength:

Returns the number of bytes contained by a CFData object.
- CFDataGetMutableBytePtr:

Returns a pointer to a mutable byte buffer of a CFMutableData object.
- CFDataGetTypeID

Returns the type identifier for the CFData opaque type.
- CFDataIncreaseLength:

Increases the length of a CFMutableData object's internal byte buffer, zero-filling the extension to the buffer.
- CFDataReplaceBytes:

Replaces those bytes in a CFMutableData object that fall within a specified range with other bytes.
- CFDataSetLength:

Resets the length of a CFMutableData object's internal byte buffer.
- CFDateCompare:

Compares two CFDate objects and returns a comparison result.
- CFDateCreate:

Creates a CFDate object given an absolute time.
- CFDateFormatterCopyProperty:

Returns a copy of a date formatter’s value for a given key.
- CFDateFormatterCreate:

Creates a new CFDateFormatter object, localized to the given locale, which will format dates to the given date and time styles.
- CFDateFormatterCreateDateFormatFromTemplate:

Returns a localized date format string representing the given date format components arranged appropriately for the specified locale.
- CFDateFormatterCreateDateFromString:

Returns a date object representing a given string.
- CFDateFormatterCreateStringWithAbsoluteTime:

Returns a string representation of the given absolute time using the specified date formatter.
- CFDateFormatterCreateStringWithDate:

Returns a string representation of the given date using the specified date formatter.
- CFDateFormatterGetAbsoluteTimeFromString:

Returns an absolute time object representing a given string.
- CFDateFormatterGetDateStyle:

Returns the date style used to create the given date formatter object.
- CFDateFormatterGetFormat:

Returns a format string for the given date formatter object.
- CFDateFormatterGetLocale:

Returns the locale object used to create the given date formatter object.
- CFDateFormatterGetTimeStyle:

Returns the time style used to create the given date formatter object.
- CFDateFormatterGetTypeID

Returns the type identifier for CFDateFormatter.
- CFDateFormatterSetFormat:

Sets the format string of the given date formatter to the specified value.
- CFDateFormatterSetProperty:

Sets a date formatter property using a key-value pair.
- CFDateGetAbsoluteTime:

Returns a CFDate object’s absolute time.
- CFDateGetTimeIntervalSinceDate:

Returns the number of elapsed seconds between the given CFDate objects.
- CFDateGetTypeID

Returns the type identifier for the CFDate opaque type.
- CFDictionaryAddValue:

Adds a key-value pair to a dictionary if the specified key is not already present.
- CFDictionaryApplyFunction:

Calls a function once for each key-value pair in a dictionary.
- CFDictionaryContainsKey:

Returns a Boolean value that indicates whether a given key is in a dictionary.
- CFDictionaryContainsValue:

Returns a Boolean value that indicates whether a given value is in a dictionary.
- CFDictionaryCreate:

Creates an immutable dictionary containing the specified key-value pairs.
- CFDictionaryCreateCopy:

Creates and returns a new immutable dictionary with the key-value pairs of another dictionary.
- CFDictionaryCreateMutable:

Creates a new mutable dictionary.
- CFDictionaryCreateMutableCopy:

Creates a new mutable dictionary with the key-value pairs from another dictionary.
- CFDictionaryGetCount:

Returns the number of key-value pairs in a dictionary.
- CFDictionaryGetCountOfKey:

Returns the number of times a key occurs in a dictionary.
- CFDictionaryGetCountOfValue:

Counts the number of times a given value occurs in the dictionary.
- CFDictionaryGetKeysAndValues:

Fills two buffers with the keys and values from a dictionary.
- CFDictionaryGetTypeID

Returns the type identifier for the CFDictionary opaque type.
- CFDictionaryGetValue:

Returns the value associated with a given key.
- CFDictionaryGetValueIfPresent:

Returns a Boolean value that indicates whether a given value for a given key is in a dictionary, and returns that value indirectly if it exists.
- CFDictionaryRemoveAllValues:

Removes all the key-value pairs from a dictionary, making it empty.
- CFDictionaryRemoveValue:

Removes a key-value pair.
- CFDictionaryReplaceValue:

Replaces a value corresponding to a given key.
- CFDictionarySetValue:

Sets the value corresponding to a given key.
- CFEqual:

Determines whether two Core Foundation objects are considered equal.
- CFErrorCopyDescription:

Returns a human-presentable description for a given error.
- CFErrorCopyFailureReason:

Returns a human-presentable failure reason for a given error.
- CFErrorCopyRecoverySuggestion:

Returns a human presentable recovery suggestion for a given error.
- CFErrorCopyUserInfo:

Returns the user info dictionary for a given CFError.
- CFErrorCreate:

Creates a new CFError object.
- CFErrorCreateWithUserInfoKeysAndValues:

Creates a new CFError object using given keys and values to create the user info dictionary.
- CFErrorGetCode:

Returns the error code for a given CFError.
- CFErrorGetDomain:

Returns the error domain for a given CFError.
- CFErrorGetTypeID

Returns the type identifier for the CFError opaque type.
- CFFileDescriptorCreate:

Creates a new CFFileDescriptor.
- CFFileDescriptorCreateRunLoopSource:

Creates a new runloop source for a given CFFileDescriptor.
- CFFileDescriptorDisableCallBacks:

Disables callbacks for a given CFFileDescriptor.
- CFFileDescriptorEnableCallBacks:

Enables callbacks for a given CFFileDescriptor.
- CFFileDescriptorGetContext:

Gets the context for a given CFFileDescriptor.
- CFFileDescriptorGetNativeDescriptor:

Returns the native file descriptor for a given CFFileDescriptor.
- CFFileDescriptorGetTypeID

Returns the type identifier for the CFFileDescriptor opaque type.
- CFFileDescriptorInvalidate:

Invalidates a CFFileDescriptor object.
- CFFileDescriptorIsValid:

Returns a Boolean value that indicates whether the native file descriptor for a given CFFileDescriptor is valid.
- CFFTPCreateParsedResourceListing:

Parses an FTP listing to a dictionary.
- CFGetAllocator:

Returns the allocator used to allocate a Core Foundation object.
- CFGetRetainCount:

Returns the reference count of a Core Foundation object.
- CFGetTypeID:

Returns the unique identifier of an opaque type to which a Core Foundation object belongs.
- CFGregorianDateGetAbsoluteTime:

Converts a Gregorian date value into an absolute time value.
- CFGregorianDateIsValid:

Checks the specified fields of a CFGregorianDate structure for valid values.
- CFHash:

Returns a code that can be used to identify an object in a hashing structure.
- CFHostCancelInfoResolution:

Cancels the resolution of a host.
- CFHostCreateCopy:

Creates a new host object by copying.
- CFHostCreateWithAddress:

Uses an address to create an instance of a host object.
- CFHostCreateWithName:

Uses a name to create an instance of a host object.
- CFHostGetAddressing:

Gets the addresses from a host.
- CFHostGetNames:

Gets the names from a CFHost.
- CFHostGetReachability:

Gets reachability information from a host.
- CFHostScheduleWithRunLoop:

Schedules a CFHost on a run loop.
- CFHostSetClient:

Associates a client context and a callback function with a CFHost object or disassociates a client context and callback function that were previously set.
- CFHostStartInfoResolution:

Starts resolution for a host object.
- CFHostUnscheduleFromRunLoop:

Unschedules a CFHost from a run loop.
- CFHTTPAuthenticationAppliesToRequest:

Returns a Boolean value that indicates whether a CFHTTPAuthentication object is associated with a CFHTTPMessage object.
- CFHTTPAuthenticationCopyDomains:

Returns an array of domain URLs to which a given CFHTTPAuthentication object can be applied.
- CFHTTPAuthenticationCopyMethod:

Gets the strongest authentication method that will be used when a CFHTTPAuthentication object is applied to a request.
- CFHTTPAuthenticationCopyRealm:

Gets an authentication information’s namespace.
- CFHTTPAuthenticationCreateFromResponse:

Uses an authentication failure response to create a CFHTTPAuthentication object.
- CFHTTPAuthenticationIsValid:

Returns a Boolean value that indicates whether a CFHTTPAuthentication object is valid.
- CFHTTPAuthenticationRequiresAccountDomain:

Returns a Boolean value that indicates whether a CFHTTPAuthentication object uses an authentication method that requires an account domain.
- CFHTTPAuthenticationRequiresOrderedRequests:

Returns a Boolean value that indicates whether authentication requests should be made one at a time.
- CFHTTPAuthenticationRequiresUserNameAndPassword:

Returns a Boolean value that indicates whether a CFHTTPAuthentication object uses an authentication method that requires a username and a password.
- CFHTTPMessageAddAuthentication:

Adds authentication information to a request.
- CFHTTPMessageAppendBytes:

Appends data to a CFHTTPMessage object.
- CFHTTPMessageApplyCredentialDictionary:

Use a dictionary containing authentication credentials to perform the authentication method specified by a CFHTTPAuthentication object.
- CFHTTPMessageApplyCredentials:

Performs the authentication method specified by a CFHTTPAuthentication object.
- CFHTTPMessageCopyAllHeaderFields:

Gets all header fields from a CFHTTPMessage object.
- CFHTTPMessageCopyBody:

Gets the body from a CFHTTPMessage object.
- CFHTTPMessageCopyHeaderFieldValue:

Gets the value of a header field from a CFHTTPMessage object.
- CFHTTPMessageCopyRequestMethod:

Gets the request method from a CFHTTPMessage object.
- CFHTTPMessageCopyRequestURL:

Gets the URL from a CFHTTPMessage object.
- CFHTTPMessageCopyResponseStatusLine:

Gets the status line from a CFHTTPMessage object.
- CFHTTPMessageCopySerializedMessage:

Serializes a CFHTTPMessage object.
- CFHTTPMessageCopyVersion:

Gets the HTTP version from a CFHTTPMessage object.
- CFHTTPMessageCreateCopy:

Gets a copy of a CFHTTPMessage object.
- CFHTTPMessageCreateEmpty:

Creates and returns a new, empty CFHTTPMessage object.
- CFHTTPMessageCreateRequest:

Creates and returns a CFHTTPMessage object for an HTTP request.
- CFHTTPMessageCreateResponse:

Creates and returns a CFHTTPMessage object for an HTTP response.
- CFHTTPMessageGetResponseStatusCode:

Gets the status code from a CFHTTPMessage object representing an HTTP response.
- CFHTTPMessageIsHeaderComplete:

Determines whether a message header is complete.
- CFHTTPMessageIsRequest:

Returns a boolean indicating whether the CFHTTPMessage is a request or a response.
- CFHTTPMessageSetBody:

Sets the body of a CFHTTPMessage object.
- CFHTTPMessageSetHeaderFieldValue:

Sets the value of a header field in an HTTP message.
- CFLocaleCopyAvailableLocaleIdentifiers

Returns an array of CFString objects that represents all locales for which locale data is available.
- CFLocaleCopyCommonISOCurrencyCodes

Returns an array of strings that represents ISO currency codes for currencies in common use.
- CFLocaleCopyCurrent

Returns a copy of the logical locale for the current user.
- CFLocaleCopyDisplayNameForPropertyValue:

Returns the display name for the given value.
- CFLocaleCopyISOCountryCodes

Returns an array of CFString objects that represents all known legal ISO country codes.
- CFLocaleCopyISOCurrencyCodes

Returns an array of CFString objects that represents all known legal ISO currency codes.
- CFLocaleCopyISOLanguageCodes

Returns an array of CFString objects that represents all known legal ISO language codes.
- CFLocaleCopyPreferredLanguages

Returns the array of canonicalized locale IDs that the user prefers.
- CFLocaleCreate:

Creates a locale for the given arbitrary locale identifier.
- CFLocaleCreateCanonicalLanguageIdentifierFromString:

Returns a canonical language identifier by mapping an arbitrary locale identification string to the canonical identifier.
- CFLocaleCreateCanonicalLocaleIdentifierFromScriptManagerCodes:

Returns a canonical locale identifier from given language and region codes.
- CFLocaleCreateCanonicalLocaleIdentifierFromString:

Returns a canonical locale identifier by mapping an arbitrary locale identification string to the canonical identifier.
- CFLocaleCreateComponentsFromLocaleIdentifier:

Returns a dictionary containing the result from parsing a locale ID consisting of language, script, country, variant, and keyword/value pairs.
- CFLocaleCreateCopy:

Returns a copy of a locale.
- CFLocaleCreateLocaleIdentifierFromComponents:

Returns a locale identifier consisting of language, script, country, variant, and keyword/value pairs derived from a dictionary containing the source information.
- CFLocaleCreateLocaleIdentifierFromWindowsLocaleCode:
- CFLocaleGetIdentifier:

Returns the given locale's identifier.
- CFLocaleGetLanguageCharacterDirection:
- CFLocaleGetLanguageLineDirection:
- CFLocaleGetSystem

Returns the root, canonical locale.
- CFLocaleGetTypeID

Returns the type identifier for the CFLocale opaque type.
- CFLocaleGetValue:

Returns the corresponding value for the given key of a locale’s key-value pair.
- CFLocaleGetWindowsLocaleCodeFromLocaleIdentifier:
- CFMachPortCreate:

Creates a CFMachPort object with a new Mach port.
- CFMachPortCreateRunLoopSource:

Creates a CFRunLoopSource object for a CFMachPort object.
- CFMachPortCreateWithPort:

Creates a CFMachPort object for a pre-existing native Mach port.
- CFMachPortGetContext:

Returns the context information for a CFMachPort object.
- CFMachPortGetInvalidationCallBack:

Returns the invalidation callback function for a CFMachPort object.
- CFMachPortGetPort:

Returns the native Mach port represented by a CFMachPort object.
- CFMachPortGetTypeID

Returns the type identifier for the CFMachPort opaque type.
- CFMachPortInvalidate:

Invalidates a CFMachPort object, stopping it from receiving any more messages.
- CFMachPortIsValid:

Returns a Boolean value that indicates whether a CFMachPort object is valid and able to receive messages.
- CFMachPortSetInvalidationCallBack:

Sets the callback function invoked when a CFMachPort object is invalidated.
- CFMakeCollectable:

Makes a newly-allocated Core Foundation object eligible for garbage collection.
- CFMessagePortCreateLocal:

Returns a local CFMessagePort object.
- CFMessagePortCreateRemote:

Returns a CFMessagePort object connected to a remote port.
- CFMessagePortCreateRunLoopSource:

Creates a CFRunLoopSource object for a CFMessagePort object.
- CFMessagePortGetContext:

Returns the context information for a CFMessagePort object.
- CFMessagePortGetInvalidationCallBack:

Returns the invalidation callback function for a CFMessagePort object.
- CFMessagePortGetName:

Returns the name with which a CFMessagePort object is registered.
- CFMessagePortGetTypeID

Returns the type identifier for the CFMessagePort opaque type.
- CFMessagePortInvalidate:

Invalidates a CFMessagePort object, stopping it from receiving or sending any more messages.
- CFMessagePortIsRemote:

Returns a Boolean value that indicates whether a CFMessagePort object represents a remote port.
- CFMessagePortIsValid:

Returns a Boolean value that indicates whether a CFMessagePort object is valid and able to send or receive messages.
- CFMessagePortSendRequest:

Sends a message to a remote CFMessagePort object.
- CFMessagePortSetDispatchQueue:

Schedules callbacks for the specified message port on the specified dispatch queue.
- CFMessagePortSetInvalidationCallBack:

Sets the callback function invoked when a CFMessagePort object is invalidated.
- CFMessagePortSetName:

Sets the name of a local CFMessagePort object.
- CFNetDiagnosticCopyNetworkStatusPassively:

Gets a network status value.
- CFNetDiagnosticCreateWithStreams:

Creates a network diagnostic object from a pair of CFStreams.
- CFNetDiagnosticCreateWithURL:

Creates a CFNetDiagnosticRef from a CFURLRef.
- CFNetDiagnosticDiagnoseProblemInteractively:

Opens a Network Diagnostics window.
- CFNetDiagnosticSetName:

Overrides the displayed application name.
- CFNetServiceBrowserCreate:

Creates an instance of a Network Service browser object.
- CFNetServiceBrowserInvalidate:

Invalidates an instance of a Network Service browser object.
- CFNetServiceBrowserScheduleWithRunLoop:

Schedules a CFNetServiceBrowser on a run loop.
- CFNetServiceBrowserSearchForDomains:

Searches for domains.
- CFNetServiceBrowserSearchForServices:

Searches a domain for services of a specified type.
- CFNetServiceBrowserStopSearch:

Stops a search for domains or services.
- CFNetServiceBrowserUnscheduleFromRunLoop:

Unschedules a CFNetServiceBrowser from a run loop and mode.
- CFNetServiceCancel:

Cancels a service registration or a service resolution.
- CFNetServiceCreate:

Creates an instance of a Network Service object.
- CFNetServiceCreateCopy:

Creates a copy of a CFNetService object.
- CFNetServiceCreateDictionaryWithTXTData:

Uses TXT record data to create a dictionary.
- CFNetServiceCreateTXTDataWithDictionary:

Flattens a set of key/value pairs into a CFDataRef suitable for passing to CFNetServiceSetTXTData.
- CFNetServiceGetAddressing:

Gets the IP addressing from a CFNetService.
- CFNetServiceGetDomain:

Gets the domain from a CFNetService.
- CFNetServiceGetName:

Gets the name from a CFNetService.
- CFNetServiceGetPortNumber:

This function gets the port number from a CFNetService.
- CFNetServiceGetTargetHost:

Queries a CFNetService for its target hosts.
- CFNetServiceGetTXTData:

Queries a network service for the contents of its TXT records.
- CFNetServiceGetType:

Gets the type from a CFNetService.
- CFNetServiceMonitorCreate:

Creates an instance of a NetServiceMonitor object that watches for record changes.
- CFNetServiceMonitorInvalidate:

Invalidates an instance of a Network Service monitor object.
- CFNetServiceMonitorScheduleWithRunLoop:

Schedules a CFNetServiceMonitor on a run loop.
- CFNetServiceMonitorStart:

Starts monitoring.
- CFNetServiceMonitorStop:

Stops a CFNetServiceMonitor.
- CFNetServiceMonitorUnscheduleFromRunLoop:

Unschedules a CFNetServiceMonitor from a run loop.
- CFNetServiceRegisterWithOptions:

Makes a CFNetService available on the network.
- CFNetServiceResolveWithTimeout:

Gets the IP address or addresses for a CFNetService.
- CFNetServiceScheduleWithRunLoop:

Schedules a CFNetService on a run loop.
- CFNetServiceSetClient:

Associates a callback function with a CFNetService or disassociates a callback function from a CFNetService.
- CFNetServiceSetTXTData:

Sets the TXT record for a CFNetService.
- CFNetServiceUnscheduleFromRunLoop:

Unschedules a CFNetService from a run loop.
- CFNetworkCopyProxiesForAutoConfigurationScript:

Executes a proxy autoconfiguration script to determine the best proxy to use to retrieve a specified URL.
- CFNetworkCopyProxiesForURL:

Returns the list of proxies that should be used to download a given URL.
- CFNetworkCopySystemProxySettings

Returns a CFDictionary containing the current systemwide internet proxy settings.
- CFNetworkExecuteProxyAutoConfigurationScript:

Downloads a proxy autoconfiguration script and executes it.
- CFNetworkExecuteProxyAutoConfigurationURL:

Downloads a proxy autoconfiguration script and executes it.
- CFNotificationCenterAddObserver:

Registers an observer to receive notifications.
- CFNotificationCenterGetDarwinNotifyCenter

Returns the application’s Darwin notification center.
- CFNotificationCenterGetLocalCenter

Returns the application’s local notification center.
- CFNotificationCenterGetTypeID

Returns the type identifier for the CFNotificationCenter opaque type.
- CFNotificationCenterPostNotification:

Posts a notification for an object.
- CFNotificationCenterPostNotificationWithOptions:

Posts a notification for an object using specified options.
- CFNotificationCenterRemoveEveryObserver:

Stops an observer from receiving any notifications from any object.
- CFNotificationCenterRemoveObserver:

Stops an observer from receiving certain notifications.
- CFNullGetTypeID

Returns the type identifier for the CFNull opaque type.
- CFNumberCompare:

Compares two CFNumber objects and returns a comparison result.
- CFNumberCreate:

Creates a CFNumber object using a specified value.
- CFNumberFormatterCopyProperty:

Returns a copy of a number formatter’s value for a given key.
- CFNumberFormatterCreate:

Creates a new CFNumberFormatter object, localized to the given locale, which will format numbers to the given style.
- CFNumberFormatterCreateNumberFromString:

Returns a number object representing a given string.
- CFNumberFormatterCreateStringWithNumber:

Returns a string representation of the given number using the specified number formatter.
- CFNumberFormatterCreateStringWithValue:

Returns a string representation of the given number or value using the specified number formatter.
- CFNumberFormatterGetDecimalInfoForCurrencyCode:

Returns the number of fraction digits that should be displayed, and the rounding increment, for a given currency.
- CFNumberFormatterGetFormat:

Returns a format string for the given number formatter object.
- CFNumberFormatterGetLocale:

Returns the locale object used to create the given number formatter object.
- CFNumberFormatterGetStyle:

Returns the number style used to create the given number formatter object.
- CFNumberFormatterGetTypeID

Returns the type identifier for the CFNumberFormatter opaque type.
- CFNumberFormatterGetValueFromString:

Returns a number or value representing a given string.
- CFNumberFormatterSetFormat:

Sets the format string of a number formatter.
- CFNumberFormatterSetProperty:

Sets a number formatter property using a key-value pair.
- CFNumberGetByteSize:

Returns the number of bytes used by a CFNumber object to store its value.
- CFNumberGetType:

Returns the type used by a CFNumber object to store its value.
- CFNumberGetTypeID

Returns the type identifier for the CFNumber opaque type.
- CFNumberGetValue:

Obtains the value of a CFNumber object cast to a specified type.
- CFNumberIsFloatType:

Determines whether a CFNumber object contains a value stored as one of the defined floating point types.
- CFPlugInAddInstanceForFactory:

Registers a new instance of a type with CFPlugIn.
- CFPlugInCreate:

Creates a CFPlugIn given its URL.
- CFPlugInFindFactoriesForPlugInType:

Searches all registered plug-ins for factory functions capable of creating an instance of the given type.
- CFPlugInFindFactoriesForPlugInTypeInPlugIn:

Searches the given plug-in for factory functions capable of creating an instance of the given type.
- CFPlugInGetBundle:

Returns a plug-in's bundle.
- CFPlugInGetTypeID

Returns the type identifier for the CFPlugIn opaque type.
- CFPlugInInstanceCreate:

Creates a CFPlugIn instance of a given type using a given factory.
- CFPlugInInstanceCreateWithInstanceDataSize:

Not recommended.
- CFPlugInInstanceGetFactoryName:

Not recommended.
- CFPlugInInstanceGetInstanceData:

Not recommended.
- CFPlugInInstanceGetInterfaceFunctionTable:

Not recommended.
- CFPlugInInstanceGetTypeID

Not recommended.
- CFPlugInIsLoadOnDemand:

Determines whether or not a plug-in is loaded on demand.
- CFPlugInRegisterFactoryFunction:

Registers a factory function and its UUID with a CFPlugIn object.
- CFPlugInRegisterFactoryFunctionByName:

Registers a factory function with a CFPlugIn object using the function's name instead of its UUID.
- CFPlugInRegisterPlugInType:

Registers a type and its corresponding factory function with a CFPlugIn object.
- CFPlugInRemoveInstanceForFactory:

Unregisters an instance of a type with CFPlugIn.
- CFPlugInSetLoadOnDemand:

Enables or disables load on demand for plug-ins that do dynamic registration (only when a client requests an instance of a supported type).
- CFPlugInUnregisterFactory:

Removes the given function from a plug-in’s list of registered factory functions.
- CFPlugInUnregisterPlugInType:

Removes the given type from a plug-in’s list of registered types.
- CFPreferencesAddSuitePreferencesToApp:

Adds suite preferences to an application’s preference search chain.
- CFPreferencesAppSynchronize:

Writes to permanent storage all pending changes to the preference data for the application, and reads the latest preference data from permanent storage.
- CFPreferencesAppValueIsForced:

Determines whether or not a given key has been imposed on the user.
- CFPreferencesCopyApplicationList:

Constructs and returns the list of all applications that have preferences in the scope of the specified user and host.
- CFPreferencesCopyAppValue:

Obtains a preference value for the specified key and application.
- CFPreferencesCopyKeyList:

Constructs and returns the list of all keys set in the specified domain.
- CFPreferencesCopyMultiple:

Returns a dictionary containing preference values for multiple keys.
- CFPreferencesCopyValue:

Returns a preference value for a given domain.
- CFPreferencesGetAppBooleanValue:

Convenience function that directly obtains a boolean preference value for the specified key.
- CFPreferencesGetAppIntegerValue:

Convenience function that directly obtains an integer preference value for the specified key.
- CFPreferencesRemoveSuitePreferencesFromApp:

Removes suite preferences from an application’s search chain.
- CFPreferencesSetAppValue:

Adds, modifies, or removes a preference.
- CFPreferencesSetMultiple:

Convenience function that allows you to set and remove multiple preference values.
- CFPreferencesSetValue:

Adds, modifies, or removes a preference value for the specified domain.
- CFPreferencesSynchronize:

For the specified domain, writes all pending changes to preference data to permanent storage, and reads latest preference data from permanent storage.
- CFPropertyListCreateData:

Returns a CFData object containing a serialized representation of a given property list in a specified format.
- CFPropertyListCreateDeepCopy:

Recursively creates a copy of a given property list.
- CFPropertyListCreateFromStream:

Creates a property list using data from a stream.
- CFPropertyListCreateFromXMLData:

Creates a property list using the specified XML or binary property list data.
- CFPropertyListCreateWithData:

Creates a property list from a given CFData object.
- CFPropertyListCreateWithStream:

Create and return a property list with a CFReadStream input.
- CFPropertyListCreateXMLData:

Creates an XML representation of the specified property list.
- CFPropertyListIsValid:

Determines if a property list is valid.
- CFPropertyListWrite:

Write the bytes of a serialized property list out to a stream.
- CFPropertyListWriteToStream:

Writes the bytes of a property list serialization out to a stream.
- CFReadStreamClose:

Closes a readable stream.
- CFReadStreamCopyError:

Returns the error associated with a stream.
- CFReadStreamCopyProperty:

Returns the value of a property for a stream.
- CFReadStreamCreateForHTTPRequest:

Creates a read stream for a CFHTTP request message.
- CFReadStreamCreateForStreamedHTTPRequest:

Creates a read stream for a CFHTTP request message object whose body is too long to keep in memory.
- CFReadStreamCreateWithBytesNoCopy:

Creates a readable stream for a block of memory.
- CFReadStreamCreateWithFile:

Creates a readable stream for a file.
- CFReadStreamCreateWithFTPURL:

Creates an FTP read stream.
- CFReadStreamGetBuffer:

Returns a pointer to a stream’s internal buffer of unread data, if possible.
- CFReadStreamGetError:

Returns the error status of a stream.
- CFReadStreamGetStatus:

Returns the current state of a stream.
- CFReadStreamGetTypeID

Returns the type identifier the CFReadStream opaque type.
- CFReadStreamHasBytesAvailable:

Returns a Boolean value that indicates whether a readable stream has data that can be read without blocking.
- CFReadStreamOpen:

Opens a stream for reading.
- CFReadStreamRead:

Reads data from a readable stream.
- CFReadStreamScheduleWithRunLoop:

Schedules a stream into a run loop.
- CFReadStreamSetClient:

Assigns a client to a stream, which receives callbacks when certain events occur.
- CFReadStreamSetProperty:

Sets the value of a property for a stream.
- CFReadStreamUnscheduleFromRunLoop:

Removes a read stream from a given run loop.
- CFRelease:

Releases a Core Foundation object.
- CFRetain:

Retains a Core Foundation object.
- CFRunLoopAddCommonMode:

Adds a mode to the set of run loop common modes.
- CFRunLoopAddObserver:

Adds a CFRunLoopObserver object to a run loop mode.
- CFRunLoopAddSource:

Adds a CFRunLoopSource object to a run loop mode.
- CFRunLoopAddTimer:

Adds a CFRunLoopTimer object to a run loop mode.
- CFRunLoopContainsObserver:

Returns a Boolean value that indicates whether a run loop mode contains a particular CFRunLoopObserver object.
- CFRunLoopContainsSource:

Returns a Boolean value that indicates whether a run loop mode contains a particular CFRunLoopSource object.
- CFRunLoopContainsTimer:

Returns a Boolean value that indicates whether a run loop mode contains a particular CFRunLoopTimer object.
- CFRunLoopCopyAllModes:

Returns an array that contains all the defined modes for a CFRunLoop object.
- CFRunLoopCopyCurrentMode:

Returns the name of the mode in which a given run loop is currently running.
- CFRunLoopGetCurrent

Returns the CFRunLoop object for the current thread.
- CFRunLoopGetMain

Returns the main CFRunLoop object.
- CFRunLoopGetNextTimerFireDate:

Returns the time at which the next timer will fire.
- CFRunLoopGetTypeID

Returns the type identifier for the CFRunLoop opaque type.
- CFRunLoopIsWaiting:

Returns a Boolean value that indicates whether the run loop is waiting for an event.
- CFRunLoopObserverCreate:

Creates a CFRunLoopObserver object.
- CFRunLoopObserverDoesRepeat:

Returns a Boolean value that indicates whether a CFRunLoopObserver repeats.
- CFRunLoopObserverGetActivities:

Returns the run loop stages during which an observer runs.
- CFRunLoopObserverGetContext:

Returns the context information for a CFRunLoopObserver object.
- CFRunLoopObserverGetOrder:

Returns the ordering parameter for a CFRunLoopObserver object.
- CFRunLoopObserverGetTypeID

Returns the type identifier for the CFRunLoopObserver opaque type.
- CFRunLoopObserverInvalidate:

Invalidates a CFRunLoopObserver object, stopping it from ever firing again.
- CFRunLoopObserverIsValid:

Returns a Boolean value that indicates whether a CFRunLoopObserver object is valid and able to fire.
- CFRunLoopPerformBlock:

Enqueues a block object on a given runloop to be executed as the runloop cycles in specified modes.
- CFRunLoopRemoveObserver:

Removes a CFRunLoopObserver object from a run loop mode.
- CFRunLoopRemoveSource:

Removes a CFRunLoopSource object from a run loop mode.
- CFRunLoopRemoveTimer:

Removes a CFRunLoopTimer object from a run loop mode.
- CFRunLoopRun

Runs the current thread’s CFRunLoop object in its default mode indefinitely.
- CFRunLoopRunInMode:

Runs the current thread’s CFRunLoop object in a particular mode.
- CFRunLoopSourceCreate:

Creates a CFRunLoopSource object.
- CFRunLoopSourceGetContext:

Returns the context information for a CFRunLoopSource object.
- CFRunLoopSourceGetOrder:

Returns the ordering parameter for a CFRunLoopSource object.
- CFRunLoopSourceGetTypeID

Returns the type identifier of the CFRunLoopSource opaque type.
- CFRunLoopSourceInvalidate:

Invalidates a CFRunLoopSource object, stopping it from ever firing again.
- CFRunLoopSourceIsValid:

Returns a Boolean value that indicates whether a CFRunLoopSource object is valid and able to fire.
- CFRunLoopSourceSignal:

Signals a CFRunLoopSource object, marking it as ready to fire.
- CFRunLoopStop:

Forces a CFRunLoop object to stop running.
- CFRunLoopTimerCreate:

Creates a new CFRunLoopTimer object.
- CFRunLoopTimerDoesRepeat:

Returns a Boolean value that indicates whether a CFRunLoopTimer object repeats.
- CFRunLoopTimerGetContext:

Returns the context information for a CFRunLoopTimer object.
- CFRunLoopTimerGetInterval:

Returns the firing interval of a repeating CFRunLoopTimer object.
- CFRunLoopTimerGetNextFireDate:

Returns the next firing time for a CFRunLoopTimer object.
- CFRunLoopTimerGetOrder:

Returns the ordering parameter for a CFRunLoopTimer object.
- CFRunLoopTimerGetTypeID

Returns the type identifier of the CFRunLoopTimer opaque type.
- CFRunLoopTimerInvalidate:

Invalidates a CFRunLoopTimer object, stopping it from ever firing again.
- CFRunLoopTimerIsValid:

Returns a Boolean value that indicates whether a CFRunLoopTimer object is valid and able to fire.
- CFRunLoopTimerSetNextFireDate:

Sets the next firing date for a CFRunLoopTimer object .
- CFRunLoopWakeUp:

Wakes a waiting CFRunLoop object.
- CFSetAddValue:

Adds a value to a CFMutableSet object.
- CFSetApplyFunction:

Calls a function once for each value in a set.
- CFSetContainsValue:

Returns a Boolean that indicates whether a set contains a given value.
- CFSetCreate:

Creates an immutable CFSet object containing supplied values.
- CFSetCreateCopy:

Creates an immutable set containing the values of an existing set.
- CFSetCreateMutable:

Creates an empty CFMutableSet object.
- CFSetCreateMutableCopy:

Creates a new mutable set with the values from another set.
- CFSetGetCount:

Returns the number of values currently in a set.
- CFSetGetCountOfValue:

Returns the number of values in a set that match a given value.
- CFSetGetTypeID

Returns the type identifier for the CFSet type.
- CFSetGetValue:

Obtains a specified value from a set.
- CFSetGetValueIfPresent:

Reports whether or not a value is in a set, and if it exists returns the value indirectly.
- CFSetGetValues:

Obtains all values in a set.
- CFSetRemoveAllValues:

Removes all values from a CFMutableSet object.
- CFSetRemoveValue:

Removes a value from a CFMutableSet object.
- CFSetReplaceValue:

Replaces a value in a CFMutableSet object.
- CFSetSetValue:

Sets a value in a CFMutableSet object.
- CFShow:

Prints a description of a Core Foundation object to stderr.
- CFShowStr:

Prints the attributes of a string during debugging.
- CFSocketConnectToAddress:

Opens a connection to a remote socket.
- CFSocketCopyAddress:

Returns the local address of a CFSocket object.
- CFSocketCopyPeerAddress:

Returns the remote address to which a CFSocket object is connected.
- CFSocketCopyRegisteredSocketSignature:

Returns a socket signature registered with a CFSocket name server.
- CFSocketCopyRegisteredValue:

Returns a value registered with a CFSocket name server.
- CFSocketCreate:

Creates a CFSocket object of a specified protocol and type.
- CFSocketCreateConnectedToSocketSignature:

Creates a CFSocket object and opens a connection to a remote socket.
- CFSocketCreateRunLoopSource:

Creates a CFRunLoopSource object for a CFSocket object.
- CFSocketCreateWithNative:

Creates a CFSocket object for a pre-existing native socket.
- CFSocketCreateWithSocketSignature:

Creates a CFSocket object using information from a CFSocketSignature structure.
- CFSocketDisableCallBacks:

Disables the callback function of a CFSocket object for certain types of socket activity.
- CFSocketEnableCallBacks:

Enables the callback function of a CFSocket object for certain types of socket activity.
- CFSocketGetContext:

Returns the context information for a CFSocket object.
- CFSocketGetDefaultNameRegistryPortNumber

Returns the default port number with which to connect to a CFSocket name server.
- CFSocketGetNative:

Returns the native socket associated with a CFSocket object.
- CFSocketGetSocketFlags:

Returns flags that control certain behaviors of a CFSocket object.
- CFSocketInvalidate:

Invalidates a CFSocket object, stopping it from sending or receiving any more messages.
- CFSocketIsValid:

Returns a Boolean value that indicates whether a CFSocket object is valid and able to send or receive messages.
- CFSocketRegisterSocketSignature:

Registers a socket signature with a CFSocket name server.
- CFSocketRegisterValue:

Registers a property-list value with a CFSocket name server.
- CFSocketSendData:

Sends data over a CFSocket object.
- CFSocketSetAddress:

Binds a local address to a CFSocket object.
- CFSocketSetDefaultNameRegistryPortNumber:

Sets the default port number with which to connect to a CFSocket name server.
- CFSocketSetSocketFlags:

Sets flags that control certain behaviors of a CFSocket object.
- CFSocketUnregister:

Unregisters a value or socket signature with a CFSocket name server.
- CFSTR:

Creates an immutable string from a constant compile-time string.
- CFStreamCreateBoundPair:

Creates a pair of read and write streams.
- CFStreamCreatePairWithPeerSocketSignature:

Creates readable and writable streams connected to a socket.
- CFStreamCreatePairWithSocket:

Creates readable and writable streams connected to a socket.
- CFStreamCreatePairWithSocketToHost:

Creates readable and writable streams connected to a TCP/IP port of a particular host.
- CFStringAppend:

Appends the characters of a string to those of a CFMutableString object.
- CFStringAppendCharacters:

Appends a buffer of Unicode characters to the character contents of a CFMutableString object.
- CFStringAppendCString:

Appends a C string to the character contents of a CFMutableString object.
- CFStringAppendFormat:

Appends a formatted string to the character contents of a CFMutableString object.
- CFStringAppendFormatAndArguments:

Appends a formatted string to the character contents of a CFMutableString object.
- CFStringAppendPascalString:

Appends a Pascal string to the character contents of a CFMutableString object.
- CFStringCapitalize:

Changes the first character in each word of a string to uppercase (if it is a lowercase alphabetical character).
- CFStringCompare:

Compares one string with another string.
- CFStringCompareWithOptions:

Compares a range of the characters in one string with that of another string.
- CFStringCompareWithOptionsAndLocale:

Compares a range of the characters in one string with another string using a given locale.
- CFStringConvertEncodingToIANACharSetName:

Returns the name of the IANA registry “charset” that is the closest mapping to a specified string encoding.
- CFStringConvertEncodingToNSStringEncoding:

Returns the Cocoa encoding constant that maps most closely to a given Core Foundation encoding constant.
- CFStringConvertEncodingToWindowsCodepage:

Returns the Windows codepage identifier that maps most closely to a given Core Foundation encoding constant.
- CFStringConvertIANACharSetNameToEncoding:

Returns the Core Foundation encoding constant that is the closest mapping to a given IANA registry “charset” name.
- CFStringConvertNSStringEncodingToEncoding:

Returns the Core Foundation encoding constant that is the closest mapping to a given Cocoa encoding.
- CFStringConvertWindowsCodepageToEncoding:

Returns the Core Foundation encoding constant that is the closest mapping to a given Windows codepage identifier.
- CFStringCreateArrayBySeparatingStrings:

Creates an array of CFString objects from a single CFString object.
- CFStringCreateArrayWithFindResults:

Searches a string for multiple occurrences of a substring and creates an array of ranges identifying the locations of these substrings within the target string.
- CFStringCreateByCombiningStrings:

Creates a single string from the individual CFString objects that comprise the elements of an array.
- CFStringCreateCopy:

Creates an immutable copy of a string.
- CFStringCreateExternalRepresentation:

Creates an “external representation” of a CFString object, that is, a CFData object.
- CFStringCreateFromExternalRepresentation:

Creates a string from its “external representation.”.
- CFStringCreateMutable:

Creates an empty CFMutableString object.
- CFStringCreateMutableCopy:

Creates a mutable copy of a string.
- CFStringCreateMutableWithExternalCharactersNoCopy:

Creates a CFMutableString object whose Unicode character buffer is controlled externally.
- CFStringCreateWithBytes:

Creates a string from a buffer containing characters in a specified encoding.
- CFStringCreateWithBytesNoCopy:

Creates a string from a buffer, containing characters in a specified encoding, that might serve as the backing store for the new string.
- CFStringCreateWithCharacters:

Creates a string from a buffer of Unicode characters.
- CFStringCreateWithCharactersNoCopy:

Creates a string from a buffer of Unicode characters that might serve as the backing store for the object.
- CFStringCreateWithCString:

Creates an immutable string from a C string.
- CFStringCreateWithCStringNoCopy:

Creates a CFString object from an external C string buffer that might serve as the backing store for the object.
- CFStringCreateWithFileSystemRepresentation:

Creates a CFString from a zero-terminated POSIX file system representation.
- CFStringCreateWithFormat:

Creates an immutable string from a formatted string and a variable number of arguments.
- CFStringCreateWithFormatAndArguments:

Creates an immutable string from a formatted string and a variable number of arguments (specified in a parameter of type va_list).
- CFStringCreateWithPascalString:

Creates an immutable CFString object from a Pascal string.
- CFStringCreateWithPascalStringNoCopy:

Creates a CFString object from an external Pascal string buffer that might serve as the backing store for the object.
- CFStringCreateWithSubstring:

Creates an immutable string from a segment (substring) of an existing string.
- CFStringDelete:

Deletes a range of characters in a string.
- CFStringFind:

Searches for a substring within a string and, if it is found, yields the range of the substring within the object's characters.
- CFStringFindAndReplace:

Replaces all occurrences of a substring within a given range.
- CFStringFindCharacterFromSet:

Query the range of the first character contained in the specified character set.
- CFStringFindWithOptions:

Searches for a substring within a range of the characters represented by a string and, if the substring is found, returns its range within the object's characters.
- CFStringFindWithOptionsAndLocale:

Returns a Boolean value that indicates whether a given string was found in a given source string.
- CFStringFold:

Folds a given string into the form specified by optional flags.
- CFStringGetBytes:

Fetches a range of the characters from a string into a byte buffer after converting the characters to a specified encoding.
- CFStringGetCharacterAtIndex:

Returns the Unicode character at a specified location in a string.
- CFStringGetCharacterFromInlineBuffer:

Returns the Unicode character at a specific location in an in-line buffer.
- CFStringGetCharacters:

Copies a range of the Unicode characters from a string to a user-provided buffer.
- CFStringGetCharactersPtr:

Quickly obtains a pointer to the contents of a string as a buffer of Unicode characters.
- CFStringGetCString:

Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.
- CFStringGetCStringPtr:

Quickly obtains a pointer to a C-string buffer containing the characters of a string in a given encoding.
- CFStringGetDoubleValue:

Returns the primary double value represented by a string.
- CFStringGetFastestEncoding:

Returns for a CFString object the character encoding that requires the least conversion time.
- CFStringGetFileSystemRepresentation:

Extracts the contents of a string as a NULL-terminated 8-bit string appropriate for passing to POSIX APIs.
- CFStringGetHyphenationLocationBeforeIndex:

Retrieve the first potential hyphenation location found before the specified location.
- CFStringGetIntValue:

Returns the integer value represented by a string.
- CFStringGetLength:

Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.
- CFStringGetLineBounds:

Given a range of characters in a string, obtains the line bounds—that is, the indexes of the first character and the final characters of the lines containing the range.
- CFStringGetListOfAvailableEncodings

Returns a pointer to a list of string encodings supported by the current system.
- CFStringGetLongCharacterForSurrogatePair:

Returns a UTF-32 character that corresponds to a given pair of UTF-16 surrogate characters.
- CFStringGetMaximumSizeForEncoding:

Returns the maximum number of bytes a string of a specified length (in Unicode characters) will take up if encoded in a specified encoding.
- CFStringGetMaximumSizeOfFileSystemRepresentation:

Determines the upper bound on the number of bytes required to hold the file system representation of the string.
- CFStringGetMostCompatibleMacStringEncoding:

Returns the most compatible Mac OS script value for the given input encoding.
- CFStringGetNameOfEncoding:

Returns the canonical name of a specified string encoding.
- CFStringGetParagraphBounds:

Given a range of characters in a string, obtains the paragraph bounds—that is, the indexes of the first character and the final characters of the paragraph(s) containing the range.
- CFStringGetPascalString:

Copies the character contents of a CFString object to a local Pascal string buffer after converting the characters to a requested encoding.
- CFStringGetPascalStringPtr:

Quickly obtains a pointer to a Pascal buffer containing the characters of a string in a given encoding.
- CFStringGetRangeOfComposedCharactersAtIndex:

Returns the range of the composed character sequence at a specified index.
- CFStringGetSmallestEncoding:

Returns the smallest encoding on the current system for the character contents of a string.
- CFStringGetSurrogatePairForLongCharacter:

Maps a given UTF-32 character to a pair of UTF-16 surrogate characters.
- CFStringGetSystemEncoding

Returns the default encoding used by the operating system when it creates strings.
- CFStringGetTypeID

Returns the type identifier for the CFString opaque type.
- CFStringHasPrefix:

Determines if the character data of a string begin with a specified sequence of characters.
- CFStringHasSuffix:

Determines if a string ends with a specified sequence of characters.
- CFStringInitInlineBuffer:

Initializes an in-line buffer to use for efficient access of a CFString object's characters.
- CFStringInsert:

Inserts a string at a specified location in the character buffer of a CFMutableString object.
- CFStringIsEncodingAvailable:

Determines whether a given Core Foundation string encoding is available on the current system.
- CFStringIsHyphenationAvailableForLocale:

Returns a Boolean value that indicates whether hyphenation data is available.
- CFStringIsSurrogateHighCharacter:

Returns a Boolean value that indicates whether a given character is a high character in a surrogate pair.
- CFStringIsSurrogateLowCharacter:

Returns a Boolean value that indicates whether a given character is a low character in a surrogate pair.
- CFStringLowercase:

Changes all uppercase alphabetical characters in a CFMutableString to lowercase.
- CFStringNormalize:

Normalizes the string into the specified form as described in Unicode Technical Report #15.
- CFStringPad:

Enlarges a string, padding it with specified characters, or truncates the string.
- CFStringReplace:

Replaces part of the character contents of a CFMutableString object with another string.
- CFStringReplaceAll:

Replaces all characters of a CFMutableString object with other characters.
- CFStringSetExternalCharactersNoCopy:

Notifies a CFMutableString object that its external backing store of Unicode characters has changed.
- CFStringTokenizerAdvanceToNextToken:

Advances the tokenizer to the next token and sets that as the current token.
- CFStringTokenizerCopyBestStringLanguage:

Guesses a language of a given string and returns the guess as a BCP 47 string.
- CFStringTokenizerCopyCurrentTokenAttribute:

Returns a given attribute of the current token.
- CFStringTokenizerCreate:

Returns a tokenizer for a given string.
- CFStringTokenizerGetCurrentSubTokens:

Retrieves the subtokens or derived subtokens contained in the compound token.
- CFStringTokenizerGetCurrentTokenRange:

Returns the range of the current token.
- CFStringTokenizerGetTypeID

Returns the type ID for CFStringTokenizer.
- CFStringTokenizerGoToTokenAtIndex:

Finds a token that includes the character at a given index, and set it as the current token.
- CFStringTokenizerSetString:

Sets the string for a tokenizer.
- CFStringTransform:

Perform in-place transliteration on a mutable string.
- CFStringTrim:

Trims a specified substring from the beginning and end of a CFMutableString object.
- CFStringTrimWhitespace:

Trims whitespace from the beginning and end of a CFMutableString object.
- CFStringUppercase:

Changes all lowercase alphabetical characters in a CFMutableString object to uppercase.
- CFSwapInt16:

Swaps the bytes of a 16-bit integer.
- CFSwapInt16BigToHost:

Converts a 16-bit integer from big-endian format to the host’s native byte order.
- CFSwapInt16HostToBig:

Converts a 16-bit integer from the host’s native byte order to big-endian format.
- CFSwapInt16HostToLittle:

Converts a 16-bit integer from the host’s native byte order to little-endian format.
- CFSwapInt16LittleToHost:

Converts a 16-bit integer from little-endian format to the host’s native byte order.
- CFSwapInt32:

Swaps the bytes of a 32-bit integer.
- CFSwapInt32BigToHost:

Converts a 32-bit integer from big-endian format to the host’s native byte order.
- CFSwapInt32HostToBig:

Converts a 32-bit integer from the host’s native byte order to big-endian format.
- CFSwapInt32HostToLittle:

Converts a 32-bit integer from the host’s native byte order to little-endian format.
- CFSwapInt32LittleToHost:

Converts a 32-bit integer from little-endian format to the host’s native byte order.
- CFSwapInt64:

Swaps the bytes of a 64-bit integer.
- CFSwapInt64BigToHost:

Converts a 64-bit integer from big-endian format to the host’s native byte order.
- CFSwapInt64HostToBig:

Converts a 64-bit integer from the host’s native byte order to big-endian format.
- CFSwapInt64HostToLittle:

Converts a 64-bit integer from the host’s native byte order to little-endian format.
- CFSwapInt64LittleToHost:

Converts a 64-bit integer from little-endian format to the host’s native byte order.
- CFTimeZoneCopyAbbreviation:

Returns the abbreviation of a time zone at a specified date.
- CFTimeZoneCopyAbbreviationDictionary

Returns a dictionary holding the mappings of time zone abbreviations to time zone names.
- CFTimeZoneCopyDefault

Returns the default time zone set for your application.
- CFTimeZoneCopyKnownNames

Returns an array of strings containing the names of all the time zones known to the system.
- CFTimeZoneCopyLocalizedName:

Returns the localized name of a given time zone.
- CFTimeZoneCopySystem

Returns the time zone currently used by the system.
- CFTimeZoneCreate:

Creates a time zone with a given name and data.
- CFTimeZoneCreateWithName:

Returns the time zone object identified by a given name or abbreviation.
- CFTimeZoneCreateWithTimeIntervalFromGMT:

Returns a time zone object for the specified time interval offset from Greenwich Mean Time (GMT).
- CFTimeZoneGetData:

Returns the data that stores the information used by a time zone.
- CFTimeZoneGetDaylightSavingTimeOffset:

Returns the daylight saving time offset for a time zone at a given time.
- CFTimeZoneGetName:

Returns the geopolitical region name that identifies a given time zone.
- CFTimeZoneGetNextDaylightSavingTimeTransition:

Returns the time in a given time zone of the next daylight saving time transition after a given time.
- CFTimeZoneGetSecondsFromGMT:

Returns the difference in seconds between the receiver and Greenwich Mean Time (GMT) at the specified date.
- CFTimeZoneGetTypeID

Returns the type identifier for the CFTimeZone opaque type.
- CFTimeZoneIsDaylightSavingTime:

Returns whether or not a time zone is in daylight savings time at a specified date.
- CFTimeZoneResetSystem

Clears the previously determined system time zone, if any.
- CFTimeZoneSetAbbreviationDictionary:

Sets the abbreviation dictionary to a given dictionary.
- CFTimeZoneSetDefault:

Sets the default time zone for your application the given time zone.
- CFTreeAppendChild:

Adds a new child to a tree as the last in its list of children.
- CFTreeApplyFunctionToChildren:

Calls a function once for each immediate child of a tree.
- CFTreeCreate:

Creates a new CFTree object.
- CFTreeFindRoot:

Returns the root tree of a given tree.
- CFTreeGetChildAtIndex:

Returns the child of a tree at the specified index.
- CFTreeGetChildCount:

Returns the number of children in a tree.
- CFTreeGetChildren:

Fills a buffer with children from the tree.
- CFTreeGetContext:

Returns the context of the specified tree.
- CFTreeGetFirstChild:

Returns the first child of a tree.
- CFTreeGetNextSibling:

Returns the next sibling, adjacent to a given tree, in the parent's children list.
- CFTreeGetParent:

Returns the parent of a given tree.
- CFTreeGetTypeID

Returns the type identifier of the CFTree opaque type.
- CFTreeInsertSibling:

Inserts a new sibling after a given tree.
- CFTreePrependChild:

Adds a new child to the specified tree as the first in its list of children.
- CFTreeRemove:

Removes a tree from its parent.
- CFTreeRemoveAllChildren:

Removes all the children of a tree.
- CFTreeSetContext:

Replaces the context of a tree by releasing the old information pointer and retaining the new one.
- CFTreeSortChildren:

Sorts the immediate children of a tree using a specified comparator function.
- CFURLCanBeDecomposed:

Determines if the given URL conforms to RFC 1808 and therefore can be decomposed.
- CFURLClearResourcePropertyCache:

Clears all cached resource property values of a given URL.
- CFURLClearResourcePropertyCacheForKey:

Discards a cached property value for a given key of a given URL.
- CFURLCopyAbsoluteURL:

Creates a new CFURL object by resolving the relative portion of a URL against its base.
- CFURLCopyFileSystemPath:

Returns the path portion of a given URL.
- CFURLCopyFragment:

Returns the fragment from a given URL.
- CFURLCopyHostName:

Returns the host name of a given URL.
- CFURLCopyLastPathComponent:

Returns the last path component of a given URL.
- CFURLCopyNetLocation:

Returns the net location portion of a given URL.
- CFURLCopyParameterString:

Returns the parameter string from a given URL.
- CFURLCopyPassword:

Returns the password of a given URL.
- CFURLCopyPath:

Returns the path portion of a given URL.
- CFURLCopyPathExtension:

Returns the path extension of a given URL.
- CFURLCopyQueryString:

Returns the query string of a given URL.
- CFURLCopyResourcePropertiesForKeys:

Returns any number of resource property values of a URL as a dictionary.
- CFURLCopyResourcePropertyForKey:

Returns the value of a given resource property of a given URL.
- CFURLCopyResourceSpecifier:

Returns any additional resource specifiers after the path.
- CFURLCopyScheme:

Returns the scheme portion of a given URL.
- CFURLCopyStrictPath:

Returns the path portion of a given URL.
- CFURLCopyUserName:

Returns the user name from a given URL.
- CFURLCreateAbsoluteURLWithBytes:

Creates a new CFURL object by resolving the relative portion of a URL, specified as bytes, against its given base URL.
- CFURLCreateBookmarkData:

Returns bookmark data for a URL, created with specified options and resource values.
- CFURLCreateBookmarkDataFromFile:

Initializes and returns bookmark data derived from a file pointed to by a specified URL.
- CFURLCreateByResolvingBookmarkData:

Returns a new URL made by resolving bookmark data.
- CFURLCreateCopyAppendingPathComponent:

Creates a copy of a given URL and appends a path component.
- CFURLCreateCopyAppendingPathExtension:

Creates a copy of a given URL and appends a path extension.
- CFURLCreateCopyDeletingLastPathComponent:

Creates a copy of a given URL with the last path component deleted.
- CFURLCreateCopyDeletingPathExtension:

Creates a copy of a given URL with its last path extension removed.
- CFURLCreateData:

Creates a CFData object containing the content of a given URL.
- CFURLCreateDataAndPropertiesFromResource:

Loads the data and properties referred to by a given URL.
- CFURLCreateFilePathURL:

Initializes and returns a newly created CFURL object as a file URL with a specified path.
- CFURLCreateFileReferenceURL:

Returns a new file reference URL that points to the same resource as a specified URL.
- CFURLCreateFromFileSystemRepresentation:

Creates a new CFURL object for a file system entity using the native representation.
- CFURLCreateFromFileSystemRepresentationRelativeToBase:

Creates a CFURL object from a native character string path relative to a base URL.
- CFURLCreateFromFSRef:

Creates a URL from a given directory or file.
- CFURLCreatePropertyFromResource:

Returns a given property specified by a given URL and property string.
- CFURLCreateResourcePropertiesForKeysFromBookmarkData:

Returns the resource values for properties identified by a specified array of keys contained in specified bookmark data.
- CFURLCreateResourcePropertyForKeyFromBookmarkData:

Returns the value of a resource property from specified bookmark data.
- CFURLCreateStringByAddingPercentEscapes:

Creates a copy of a string, replacing certain characters with the equivalent percent escape sequence based on the specified encoding.
- CFURLCreateStringByReplacingPercentEscapes:

Creates a new string by replacing any percent escape sequences with their character equivalent.
- CFURLCreateStringByReplacingPercentEscapesUsingEncoding:

Creates a new string by replacing any percent escape sequences with their character equivalent.
- CFURLCreateWithBytes:

Creates a CFURL object using a given character bytes.
- CFURLCreateWithFileSystemPath:

Creates a CFURL object using a local file system path string.
- CFURLCreateWithFileSystemPathRelativeToBase:

Creates a CFURL object using a local file system path string relative to a base URL.
- CFURLCreateWithString:

Creates a CFURL object using a given CFString object.
- CFURLDestroyResource:

Destroys a resource indicated by a given URL.
- CFURLGetBaseURL:

Returns the base URL of a given URL if it exists.
- CFURLGetByteRangeForComponent:

Returns the range of the specified component in the bytes of a URL.
- CFURLGetBytes:

Returns by reference the byte representation of a URL object.
- CFURLGetFileSystemRepresentation:

Fills a buffer with the file system's native string representation of a given URL's path.
- CFURLGetFSRef:

Converts a given URL to a file or directory object.
- CFURLGetPortNumber:

Returns the port number from a given URL.
- CFURLGetString:

Returns the URL as a CFString object.
- CFURLGetTypeID

Returns the type identifier for the CFURL opaque type.
- CFURLHasDirectoryPath:

Determines if a given URL's path represents a directory.
- CFURLResourceIsReachable:

Returns whether the resource pointed to by a file URL can be reached.
- CFURLSetResourcePropertiesForKeys:

Sets resource properties of a URL specified by a given dictionary of keys and values.
- CFURLSetResourcePropertyForKey:

Sets the resource property of the URL specified by a given key to a given value.
- CFURLSetTemporaryResourcePropertyForKey:

Sets the resource property of the URL specified by a given key to a given value without writing the assignment to the backing store.
- CFURLWriteBookmarkDataToFile:

Creates an alias file on disk at a specified location with specified bookmark data.
- CFURLWriteDataAndPropertiesToResource:

Writes the given data and properties to a given URL.
- CFUUIDCreate:

Creates a Universally Unique Identifier (UUID) object.
- CFUUIDCreateFromString:

Creates a CFUUID object for a specified string.
- CFUUIDCreateFromUUIDBytes:

Creates a CFUUID object from raw UUID bytes.
- CFUUIDCreateString:

Returns the string representation of a specified CFUUID object.
- CFUUIDCreateWithBytes:

Creates a CFUUID object from raw UUID bytes.
- CFUUIDGetConstantUUIDWithBytes:

Returns a CFUUID object from raw UUID bytes.
- CFUUIDGetTypeID

Returns the type identifier for all CFUUID objects.
- CFUUIDGetUUIDBytes:

Returns the value of a UUID object as raw bytes.
- CFWriteStreamCanAcceptBytes:

Returns whether a writable stream can accept new data without blocking.
- CFWriteStreamClose:

Closes a writable stream.
- CFWriteStreamCopyError:

Returns the error associated with a stream.
- CFWriteStreamCopyProperty:

Returns the value of a property for a stream.
- CFWriteStreamCreateWithAllocatedBuffers:

Creates a writable stream for a growable block of memory.
- CFWriteStreamCreateWithBuffer:

Creates a writable stream for a fixed-size block of memory.
- CFWriteStreamCreateWithFile:

Creates a writable stream for a file.
- CFWriteStreamCreateWithFTPURL:

Creates an FTP write stream.
- CFWriteStreamGetError:

Returns the error status of a stream.
- CFWriteStreamGetStatus:

Returns the current state of a stream.
- CFWriteStreamGetTypeID

Returns the type identifier of all CFWriteStream objects.
- CFWriteStreamOpen:

Opens a stream for writing.
- CFWriteStreamScheduleWithRunLoop:

Schedules a stream into a run loop.
- CFWriteStreamSetClient:

Assigns a client to a stream, which receives callbacks when certain events occur.
- CFWriteStreamSetProperty:

Sets the value of a property for a stream.
- CFWriteStreamUnscheduleFromRunLoop:

Removes a stream from a particular run loop.
- CFWriteStreamWrite:

Writes data to a writable stream.
- CGAffineTransformConcat:

Returns an affine transformation matrix constructed by combining two existing affine transforms.
- CGAffineTransformEqualToTransform:

Checks whether two affine transforms are equal.
- CGAffineTransformFromString:

Returns a Core Graphics affine transform structure corresponding to the data in a given string.
- CGAffineTransformInvert:

Returns an affine transformation matrix constructed by inverting an existing affine transform.
- CGAffineTransformIsIdentity:

Checks whether an affine transform is the identity transform.
- CGAffineTransformMake:

Returns an affine transformation matrix constructed from values you provide.
- CGAffineTransformMakeRotation:

Returns an affine transformation matrix constructed from a rotation value you provide.
- CGAffineTransformMakeScale:

Returns an affine transformation matrix constructed from scaling values you provide.
- CGAffineTransformMakeTranslation:

Returns an affine transformation matrix constructed from translation values you provide.
- CGAffineTransformRotate:

Returns an affine transformation matrix constructed by rotating an existing affine transform.
- CGAffineTransformScale:

Returns an affine transformation matrix constructed by scaling an existing affine transform.
- CGAffineTransformTranslate:

Returns an affine transformation matrix constructed by translating an existing affine transform.
- CGBitmapContextCreate:

Creates a bitmap graphics context.
- CGBitmapContextCreateImage:

Creates and returns a Quartz image from the pixel data in a bitmap graphics context.
- CGBitmapContextCreateWithData:

Creates a bitmap graphics context with the specified callback function.
- CGBitmapContextGetAlphaInfo:

Returns the alpha information associated with the context, which indicates how a bitmap context handles the alpha component.
- CGBitmapContextGetBitmapInfo:

Obtains the bitmap information associated with a bitmap graphics context.
- CGBitmapContextGetBitsPerComponent:

Returns the bits per component of a bitmap context.
- CGBitmapContextGetBitsPerPixel:

Returns the bits per pixel of a bitmap context.
- CGBitmapContextGetBytesPerRow:

Returns the bytes per row of a bitmap context.
- CGBitmapContextGetColorSpace:

Returns the color space of a bitmap context.
- CGBitmapContextGetData:

Returns a pointer to the image data associated with a bitmap context.
- CGBitmapContextGetHeight:

Returns the height in pixels of a bitmap context.
- CGBitmapContextGetWidth:

Returns the width in pixels of a bitmap context.
- CGColorCreate:

Creates a Quartz color using a list of intensity values (including alpha) and an associated color space.
- CGColorCreateCopy:

Creates a copy of an existing Quartz color.
- CGColorCreateCopyWithAlpha:

Creates a copy of an existing Quartz color, substituting a new alpha value.
- CGColorCreateWithPattern:

Creates a Quartz color using a list of intensity values (including alpha), a pattern color space, and a pattern.
- CGColorEqualToColor:

Indicates whether two colors are equal.
- CGColorGetAlpha:

Returns the value of the alpha component associated with a Quartz color.
- CGColorGetColorSpace:

Returns the color space associated with a Quartz color.
- CGColorGetComponents:

Returns the values of the color components (including alpha) associated with a Quartz color.
- CGColorGetNumberOfComponents:

Returns the number of color components (including alpha) associated with a Quartz color.
- CGColorGetPattern:

Returns the pattern associated with a Quartz color in a pattern color space.
- CGColorGetTypeID

Returns the Core Foundation type identifier for a Quartz color data type.
- CGColorRelease:

Decrements the retain count of a Quartz color.
- CGColorRetain:

Increments the retain count of a Quartz color.
- CGColorSpaceCreateCalibratedGray:

Creates a calibrated grayscale color space.
- CGColorSpaceCreateCalibratedRGB:

Creates a calibrated RGB color space.
- CGColorSpaceCreateDeviceCMYK

Creates a device-dependent CMYK color space.
- CGColorSpaceCreateDeviceGray

Creates a device-dependent grayscale color space.
- CGColorSpaceCreateDeviceRGB

Creates a device-dependent RGB color space.
- CGColorSpaceCreateICCBased:

Creates a device-independent color space that is defined according to the ICC color profile specification.
- CGColorSpaceCreateIndexed:

Creates an indexed color space, consisting of colors specified by a color lookup table.
- CGColorSpaceCreateLab:

Creates a device-independent color space that is relative to human color perception, according to the CIE L*a*b* standard.
- CGColorSpaceCreatePattern:

Creates a pattern color space.
- CGColorSpaceCreateWithICCProfile:

Creates an ICC-based color space using the ICC profile contained in the specified data.
- CGColorSpaceCreateWithName:

Creates a specified type of Quartz color space.
- CGColorSpaceGetBaseColorSpace:

Returns the base color space of a pattern or indexed color space.
- CGColorSpaceGetColorTable:

Copies the entries in the color table of an indexed color space.
- CGColorSpaceGetColorTableCount:

Returns the number of entries in the color table of an indexed color space.
- CGColorSpaceGetModel:

Returns the color space model of the provided color space.
- CGColorSpaceGetNumberOfComponents:

Returns the number of color components in a color space.
- CGColorSpaceGetTypeID

Returns the Core Foundation type identifier for Quartz color spaces.
- CGColorSpaceRelease:

Decrements the retain count of a color space.
- CGColorSpaceRetain:

Increments the retain count of a color space.
- CGContextAddArc:

Adds an arc of a circle to the current path, possibly preceded by a straight line segment.
- CGContextAddArcToPoint:

Adds an arc of a circle to the current path, using a radius and tangent points.
- CGContextAddCurveToPoint:

Appends a cubic Bézier curve from the current point, using the provided control points and end point .
- CGContextAddEllipseInRect:

Adds an ellipse that fits inside the specified rectangle.
- CGContextAddLines:

Adds a sequence of connected straight-line segments to the current path.
- CGContextAddLineToPoint:

Appends a straight line segment from the current point to the provided point .
- CGContextAddPath:

Adds a previously created Quartz path object to the current path in a graphics context.
- CGContextAddQuadCurveToPoint:

Appends a quadratic Bézier curve from the current point, using a control point and an end point you specify.
- CGContextAddRect:

Adds a rectangular path to the current path.
- CGContextAddRects:

Adds a set rectangular paths to the current path.
- CGContextBeginPage:

Starts a new page in a page-based graphics context.
- CGContextBeginPath:

Creates a new empty path in a graphics context.
- CGContextBeginTransparencyLayer:

Begins a transparency layer.
- CGContextBeginTransparencyLayerWithRect:

Begins a transparency layer whose contents are bounded by the specified rectangle.
- CGContextClearRect:

Paints a transparent rectangle.
- CGContextClip:

Modifies the current clipping path, using the nonzero winding number rule.
- CGContextClipToMask:

Maps a mask into the specified rectangle and intersects it with the current clipping area of the graphics context.
- CGContextClipToRect:

Sets the clipping path to the intersection of the current clipping path with the area defined by the specified rectangle.
- CGContextClipToRects:

Sets the clipping path to the intersection of the current clipping path with the region defined by an array of rectangles.
- CGContextClosePath:

Closes and terminates the current path’s subpath.
- CGContextConcatCTM:

Transforms the user coordinate system in a context using a specified matrix.
- CGContextConvertPointToDeviceSpace:

Returns a point that is transformed from user space coordinates to device space coordinates.
- CGContextConvertPointToUserSpace:

Returns a point that is transformed from device space coordinates to user space coordinates.
- CGContextConvertRectToDeviceSpace:

Returns a rectangle that is transformed from user space coordinate to device space coordinates.
- CGContextConvertRectToUserSpace:

Returns a rectangle that is transformed from device space coordinate to user space coordinates.
- CGContextConvertSizeToDeviceSpace:

Returns a size that is transformed from user space coordinates to device space coordinates.
- CGContextConvertSizeToUserSpace:

Returns a size that is transformed from device space coordinates to user space coordinates.
- CGContextCopyPath:

Returns a Quartz path object built from the current path information in a graphics context.
- CGContextDrawImage:

Draws an image into a graphics context.
- CGContextDrawLayerAtPoint:

Draws the contents of a CGLayer object at the specified point.
- CGContextDrawLayerInRect:

Draws the contents of a CGLayer object into the specified rectangle.
- CGContextDrawLinearGradient:

Paints a gradient fill that varies along the line defined by the provided starting and ending points.
- CGContextDrawPath:

Draws the current path using the provided drawing mode.
- CGContextDrawPDFPage:

Draws a page in the current user space of a PDF context.
- CGContextDrawRadialGradient:

Paints a gradient fill that varies along the area defined by the provided starting and ending circles.
- CGContextDrawShading:

Fills the clipping path of a context with the specified shading.
- CGContextDrawTiledImage:

Repeatedly draws an image, scaled to the provided rectangle, to fill the current clip region.
- CGContextEndPage:

Ends the current page in a page-based graphics context.
- CGContextEndTransparencyLayer:

Ends a transparency layer.
- CGContextEOClip:

Modifies the current clipping path, using the even-odd rule.
- CGContextEOFillPath:

Paints the area within the current path, using the even-odd fill rule.
- CGContextFillEllipseInRect:

Paints the area of the ellipse that fits inside the provided rectangle, using the fill color in the current graphics state.
- CGContextFillPath:

Paints the area within the current path, using the nonzero winding number rule.
- CGContextFillRect:

Paints the area contained within the provided rectangle, using the fill color in the current graphics state.
- CGContextFillRects:

Paints the areas contained within the provided rectangles, using the fill color in the current graphics state.
- CGContextFlush:

Forces all pending drawing operations in a window context to be rendered immediately to the destination device.
- CGContextGetClipBoundingBox:

Returns the bounding box of a clipping path.
- CGContextGetCTM:

Returns the current transformation matrix.
- CGContextGetInterpolationQuality:

Returns the current level of interpolation quality for a graphics context.
- CGContextGetPathBoundingBox:

Returns the smallest rectangle that contains the current path.
- CGContextGetPathCurrentPoint:

Returns the current point in a non-empty path.
- CGContextGetTextMatrix:

Returns the current text matrix.
- CGContextGetTextPosition:

Returns the location at which text is drawn.
- CGContextGetTypeID

Returns the type identifier for Quartz graphics contexts.
- CGContextGetUserSpaceToDeviceSpaceTransform:

Returns an affine transform that maps user space coordinates to device space coordinates.
- CGContextIsPathEmpty:

Indicates whether the current path contains any subpaths.
- CGContextMoveToPoint:

Begins a new subpath at the point you specify.
- CGContextPathContainsPoint:

Checks to see whether the specified point is contained in the current path.
- CGContextRelease:

Decrements the retain count of a graphics context.
- CGContextReplacePathWithStrokedPath:

Replaces the path in the graphics context with the stroked version of the path.
- CGContextRestoreGState:

Sets the current graphics state to the state most recently saved.
- CGContextRetain:

Increments the retain count of a graphics context.
- CGContextRotateCTM:

Rotates the user coordinate system in a context.
- CGContextSaveGState:

Pushes a copy of the current graphics state onto the graphics state stack for the context.
- CGContextScaleCTM:

Changes the scale of the user coordinate system in a context.
- CGContextSelectFont:

Sets the font and font size in a graphics context.
- CGContextSetAllowsAntialiasing:

Sets whether or not to allow anti-aliasing for a graphics context.
- CGContextSetAllowsFontSmoothing:

Sets whether or not to allow font smoothing for a graphics context.
- CGContextSetAllowsFontSubpixelPositioning:

Sets whether or not to allow subpixel positioning for a graphics context.
- CGContextSetAllowsFontSubpixelQuantization:

Sets whether or not to allow subpixel quantization for a graphics context.
- CGContextSetAlpha:

Sets the opacity level for objects drawn in a graphics context.
- CGContextSetBlendMode:

Sets how Quartz composites sample values for a graphics context.
- CGContextSetCharacterSpacing:

Sets the current character spacing.
- CGContextSetCMYKFillColor:

Sets the current fill color to a value in the DeviceCMYK color space.
- CGContextSetCMYKStrokeColor:

Sets the current stroke color to a value in the DeviceCMYK color space.
- CGContextSetFillColor:

Sets the current fill color.
- CGContextSetFillColorSpace:

Sets the fill color space in a graphics context.
- CGContextSetFillColorWithColor:

Sets the current fill color in a graphics context, using a Quartz color.
- CGContextSetFillPattern:

Sets the fill pattern in the specified graphics context.
- CGContextSetFlatness:

Sets the accuracy of curved paths in a graphics context.
- CGContextSetFont:

Sets the platform font in a graphics context.
- CGContextSetFontSize:

Sets the current font size.
- CGContextSetGrayFillColor:

Sets the current fill color to a value in the DeviceGray color space.
- CGContextSetGrayStrokeColor:

Sets the current stroke color to a value in the DeviceGray color space.
- CGContextSetInterpolationQuality:

Sets the level of interpolation quality for a graphics context.
- CGContextSetLineCap:

Sets the style for the endpoints of lines drawn in a graphics context.
- CGContextSetLineDash:

Sets the pattern for dashed lines in a graphics context.
- CGContextSetLineJoin:

Sets the style for the joins of connected lines in a graphics context.
- CGContextSetLineWidth:

Sets the line width for a graphics context.
- CGContextSetMiterLimit:

Sets the miter limit for the joins of connected lines in a graphics context.
- CGContextSetPatternPhase:

Sets the pattern phase of a context.
- CGContextSetRenderingIntent:

Sets the rendering intent in the current graphics state.
- CGContextSetRGBFillColor:

Sets the current fill color to a value in the DeviceRGB color space.
- CGContextSetRGBStrokeColor:

Sets the current stroke color to a value in the DeviceRGB color space.
- CGContextSetShadow:

Enables shadowing in a graphics context.
- CGContextSetShadowWithColor:

Enables shadowing with color a graphics context.
- CGContextSetShouldAntialias:

Sets anti-aliasing on or off for a graphics context.
- CGContextSetShouldSmoothFonts:

Enables or disables font smoothing in a graphics context.
- CGContextSetShouldSubpixelPositionFonts:

Enables or disables subpixel positioning in a graphics context.
- CGContextSetShouldSubpixelQuantizeFonts:

Enables or disables subpixel quantization in a graphics context.
- CGContextSetStrokeColor:

Sets the current stroke color.
- CGContextSetStrokeColorSpace:

Sets the stroke color space in a graphics context.
- CGContextSetStrokeColorWithColor:

Sets the current stroke color in a context, using a Quartz color.
- CGContextSetStrokePattern:

Sets the stroke pattern in the specified graphics context.
- CGContextSetTextDrawingMode:

Sets the current text drawing mode.
- CGContextSetTextMatrix:

Sets the current text matrix.
- CGContextSetTextPosition:

Sets the location at which text is drawn.
- CGContextShowGlyphs:

Displays an array of glyphs at the current text position.
- CGContextShowGlyphsAtPoint:

Displays an array of glyphs at a position you specify.
- CGContextShowGlyphsAtPositions:

Draws glyphs at the provided position.
- CGContextShowGlyphsWithAdvances:

Draws an array of glyphs with varying offsets.
- CGContextShowText:

Displays a character array at the current text position, a point specified by the current text matrix.
- CGContextShowTextAtPoint:

Displays a character string at a position you specify.
- CGContextStrokeEllipseInRect:

Strokes an ellipse that fits inside the specified rectangle.
- CGContextStrokeLineSegments:

Strokes a sequence of line segments.
- CGContextStrokePath:

Paints a line along the current path.
- CGContextStrokeRect:

Paints a rectangular path.
- CGContextStrokeRectWithWidth:

Paints a rectangular path, using the specified line width.
- CGContextSynchronize:

Marks a window context for update.
- CGContextTranslateCTM:

Changes the origin of the user coordinate system in a context.
- CGDataConsumerCreate:

Creates a data consumer that uses callback functions to write data.
- CGDataConsumerCreateWithCFData:

Creates a data consumer that writes to a CFData object.
- CGDataConsumerCreateWithURL:

Creates a data consumer that writes data to a location specified by a URL.
- CGDataConsumerGetTypeID

Returns the Core Foundation type identifier for Quartz data consumers.
- CGDataConsumerRelease:

Decrements the retain count of a data consumer.
- CGDataConsumerRetain:

Increments the retain count of a data consumer.
- CGDataProviderCopyData:

Returns a copy of the provider’s data.
- CGDataProviderCreateDirect:

Creates a Quartz direct-access data provider.
- CGDataProviderCreateSequential:

Creates a Quartz sequential-access data provider.
- CGDataProviderCreateWithCFData:

Creates a Quartz data provider that reads from a CFData object.
- CGDataProviderCreateWithData:

Creates a Quartz direct-access data provider that uses data your program supplies.
- CGDataProviderCreateWithFilename:

Creates a Quartz direct-access data provider that uses a file to supply data.
- CGDataProviderCreateWithURL:

Creates a Quartz direct-access data provider that uses a URL to supply data.
- CGDataProviderGetTypeID

Returns the Core Foundation type identifier for Quartz data providers.
- CGDataProviderRelease:

Decrements the retain count of a data provider.
- CGDataProviderRetain:

Increments the retain count of a data provider.
- CGFontCanCreatePostScriptSubset:

Determines whether Quartz can create a subset of the font in PostScript format.
- CGFontCopyFullName:

Returns the full name associated with a font object.
- CGFontCopyGlyphNameForGlyph:

Returns the glyph name of the specified glyph in the specified font.
- CGFontCopyPostScriptName:

Obtains the PostScript name of a font.
- CGFontCopyTableForTag:

Returns the font table that corresponds to the provided tag.
- CGFontCopyTableTags:

Returns an array of tags that correspond to the font tables for a font.
- CGFontCopyVariationAxes:

Returns an array of the variation axis dictionaries for a font.
- CGFontCopyVariations:

Returns the variation specification dictionary for a font.
- CGFontCreateCopyWithVariations:

Creates a copy of a font using a variation specification dictionary.
- CGFontCreatePostScriptEncoding:

Creates a PostScript encoding of a font.
- CGFontCreatePostScriptSubset:

Creates a subset of the font in the specified PostScript format.
- CGFontCreateWithDataProvider:

Creates a font object from data supplied from a data provider.
- CGFontCreateWithFontName:

Creates a font object corresponding to the font specified by a PostScript or full name.
- CGFontGetAscent:

Returns the ascent of a font.
- CGFontGetCapHeight:

Returns the cap height of a font.
- CGFontGetDescent:

Returns the descent of a font.
- CGFontGetFontBBox:

Returns the bounding box of a font.
- CGFontGetGlyphAdvances:

Gets the advance width of each glyph in the provided array.
- CGFontGetGlyphBBoxes:

Get the bounding box of each glyph in an array.
- CGFontGetGlyphWithGlyphName:

Returns the glyph for the glyph name associated with the specified font object.
- CGFontGetItalicAngle:

Returns the italic angle of a font.
- CGFontGetLeading:

Returns the leading of a font.
- CGFontGetNumberOfGlyphs:

Returns the number of glyphs in a font.
- CGFontGetStemV:

Returns the thickness of the dominant vertical stems of glyphs in a font.
- CGFontGetTypeID

Returns the Core Foundation type identifier for Quartz fonts.
- CGFontGetUnitsPerEm:

Returns the number of glyph space units per em for the provided font.
- CGFontGetXHeight:

Returns the x-height of a font.
- CGFontRelease:

Decrements the retain count of a Quartz font.
- CGFontRetain:

Increments the retain count of a Quartz font.
- CGFunctionCreate:

Creates a Quartz function.
- CGFunctionGetTypeID

Returns the type identifier for Quartz function objects.
- CGFunctionRelease:

Decrements the retain count of a function object.
- CGFunctionRetain:

Increments the retain count of a function object.
- CGGradientCreateWithColorComponents:

Creates a CGGradient object from a color space and the provided color components and locations.
- CGGradientCreateWithColors:

Creates a CGGradient object from a color space and the provided color objects and locations.
- CGGradientGetTypeID

Returns the Core Foundation type identifier for CGGradient objects.
- CGGradientRelease:

Decrements the retain count of a CGGradient object.
- CGGradientRetain:

Increments the retain count of a CGGradient object.
- CGImageCreate:

Creates a bitmap image from data supplied by a data provider.
- CGImageCreateCopy:

Creates a copy of a bitmap image.
- CGImageCreateCopyWithColorSpace:

Create a copy of a bitmap image, replacing its colorspace.
- CGImageCreateWithImageInRect:

Creates a bitmap image using the data contained within a subregion of an existing bitmap image.
- CGImageCreateWithJPEGDataProvider:

Creates a bitmap image using JPEG-encoded data supplied by a data provider.
- CGImageCreateWithMask:

Creates a bitmap image from an existing image and an image mask.
- CGImageCreateWithMaskingColors:

Creates a bitmap image by masking an existing bitmap image with the provided color values.
- CGImageCreateWithPNGDataProvider:

Creates a Quartz bitmap image using PNG-encoded data supplied by a data provider.
- CGImageDestinationAddImage:

Adds an image to an image destination.
- CGImageDestinationAddImageFromSource:

Adds an image from an image source to an image destination.
- CGImageDestinationCopyTypeIdentifiers

Returns an array of the uniform type identifiers (UTIs) that are supported for image destinations.
- CGImageDestinationCreateWithData:

Creates an image destination that writes to a Core Foundation mutable data object.
- CGImageDestinationCreateWithDataConsumer:

Creates an image destination that writes to the specified data consumer.
- CGImageDestinationCreateWithURL:

Creates an image destination that writes to a location specified by a URL.
- CGImageDestinationFinalize:

Writes image data and properties to the data, URL, or data consumer associated with the image destination.
- CGImageDestinationGetTypeID

Returns the unique type identifier of an image destination opaque type.
- CGImageDestinationSetProperties:

Applies one or more properties to all images in an image destination.
- CGImageGetAlphaInfo:

Returns the alpha channel information for a bitmap image.
- CGImageGetBitmapInfo:

Returns the bitmap information for a bitmap image.
- CGImageGetBitsPerComponent:

Returns the number of bits allocated for a single color component of a bitmap image.
- CGImageGetBitsPerPixel:

Returns the number of bits allocated for a single pixel in a bitmap image.
- CGImageGetBytesPerRow:

Returns the number of bytes allocated for a single row of a bitmap image.
- CGImageGetColorSpace:

Return the color space for a bitmap image.
- CGImageGetDataProvider:

Returns the data provider for a bitmap image.
- CGImageGetDecode:

Returns the decode array for a bitmap image.
- CGImageGetHeight:

Returns the height of a bitmap image.
- CGImageGetRenderingIntent:

Returns the rendering intent setting for a bitmap image.
- CGImageGetShouldInterpolate:

Returns the interpolation setting for a bitmap image.
- CGImageGetTypeID

Returns the type identifier for Quartz bitmap images.
- CGImageGetWidth:

Returns the width of a bitmap image.
- CGImageIsMask:

Returns whether a bitmap image is an image mask.
- CGImageMaskCreate:

Creates a bitmap image mask from data supplied by a data provider.
- CGImageRelease:

Decrements the retain count of a bitmap image.
- CGImageRetain:

Increments the retain count of a bitmap image.
- CGImageSourceCopyProperties:

Returns the properties of the image source.
- CGImageSourceCopyPropertiesAtIndex:

Returns the properties of the image at a specified location in an image source.
- CGImageSourceCopyTypeIdentifiers

Returns an array of uniform type identifiers (UTIs) that are supported for image sources.
- CGImageSourceCreateImageAtIndex:

Creates a CGImage object for the image data associated with the specified index in an image source.
- CGImageSourceCreateIncremental:

Create an incremental image source.
- CGImageSourceCreateThumbnailAtIndex:

Creates a thumbnail image of the image located at a specified location in an image source.
- CGImageSourceCreateWithData:

Creates an image source that reads from a Core Foundation data object.
- CGImageSourceCreateWithDataProvider:

Creates an image source that reads data from the specified data provider.
- CGImageSourceCreateWithURL:

Creates an image source that reads from a location specified by a URL.
- CGImageSourceGetCount:

Returns the number of images (not including thumbnails) in the image source.
- CGImageSourceGetStatus:

Return the status of an image source.
- CGImageSourceGetStatusAtIndex:

Returns the current status of an image that is at a specified location in an image source.
- CGImageSourceGetType:

Returns the uniform type identifier of the source container.
- CGImageSourceGetTypeID

Returns the unique type identifier of an image source opaque type.
- CGImageSourceUpdateData:

Updates an incremental image source with new data.
- CGImageSourceUpdateDataProvider:

Updates an incremental image source with a new data provider.
- CGLayerCreateWithContext:

Creates a CGLayer object that is associated with a graphics context.
- CGLayerGetContext:

Returns the graphics context associated with a CGLayer object.
- CGLayerGetSize:

Returns the width and height of a CGLayer object.
- CGLayerGetTypeID

Returns the unique type identifier used for CGLayer objects.
- CGLayerRelease:

Decrements the retain count of a CGLayer object.
- CGLayerRetain:

Increments the retain count of a CGLayer object.
- CGPathAddArc:

Appends an arc to a mutable graphics path, possibly preceded by a straight line segment.
- CGPathAddArcToPoint:

Appends an arc to a mutable graphics path, possibly preceded by a straight line segment.
- CGPathAddCurveToPoint:

Appends a cubic Bézier curve to a mutable graphics path.
- CGPathAddEllipseInRect:

Adds to a path an ellipse that fits inside a rectangle.
- CGPathAddLines:

Appends an array of new line segments to a mutable graphics path.
- CGPathAddLineToPoint:

Appends a line segment to a mutable graphics path.
- CGPathAddPath:

Appends a path to onto a mutable graphics path.
- CGPathAddQuadCurveToPoint:

Appends a quadratic Bézier curve to a mutable graphics path.
- CGPathAddRect:

Appends a rectangle to a mutable graphics path.
- CGPathAddRects:

Appends an array of rectangles to a mutable graphics path.
- CGPathAddRelativeArc:

Appends an arc to a mutable graphics path, possibly preceded by a straight line segment.
- CGPathApply:

For each element in a graphics path, calls a custom applier function.
- CGPathCloseSubpath:

Closes and completes a subpath in a mutable graphics path.
- CGPathContainsPoint:

Checks whether a point is contained in a graphics path.
- CGPathCreateCopy:

Creates an immutable copy of a graphics path.
- CGPathCreateCopyByDashingPath:

Creates a dashed copy of another path.
- CGPathCreateCopyByStrokingPath:

Creates a stroked copy of another path.
- CGPathCreateCopyByTransformingPath:

Creates an immutable copy of a graphics path transformed by a transformation matrix.
- CGPathCreateMutable

Creates a mutable graphics path.
- CGPathCreateMutableCopy:

Creates a mutable copy of an existing graphics path.
- CGPathCreateMutableCopyByTransformingPath:

Creates a mutable copy of a graphics path transformed by a transformation matrix.
- CGPathCreateWithEllipseInRect:

Create an immutable path of an ellipse.
- CGPathCreateWithRect:

Create an immutable path of a rectangle.
- CGPathEqualToPath:

Indicates whether two graphics paths are equivalent.
- CGPathGetBoundingBox:

Returns the bounding box containing all points in a graphics path.
- CGPathGetCurrentPoint:

Returns the current point in a graphics path.
- CGPathGetPathBoundingBox:

Returns the bounding box of a graphics path.
- CGPathGetTypeID

Returns the Core Foundation type identifier for Quartz graphics paths.
- CGPathIsEmpty:

Indicates whether or not a graphics path is empty.
- CGPathIsRect:

Indicates whether or not a graphics path represents a rectangle.
- CGPathMoveToPoint:

Starts a new subpath at a specified location in a mutable graphics path.
- CGPathRelease:

Decrements the retain count of a graphics path.
- CGPathRetain:

Increments the retain count of a graphics path.
- CGPatternCreate:

Creates a pattern object.
- CGPatternGetTypeID

Returns the type identifier for Quartz patterns.
- CGPatternRelease:

Decrements the retain count of a Quartz pattern.
- CGPatternRetain:

Increments the retain count of a Quartz pattern.
- CGPDFArrayGetArray:

Returns whether an object at a given index in a PDF array is another PDF array and, if so, retrieves that array.
- CGPDFArrayGetBoolean:

Returns whether an object at a given index in a PDF array is a PDF Boolean and, if so, retrieves that Boolean.
- CGPDFArrayGetCount:

Returns the number of items in a PDF array.
- CGPDFArrayGetDictionary:

Returns whether an object at a given index in a PDF array is a PDF dictionary and, if so, retrieves that dictionary.
- CGPDFArrayGetInteger:

Returns whether an object at a given index in a PDF array is a PDF integer and, if so, retrieves that object.
- CGPDFArrayGetName:

Returns whether an object at a given index in a PDF array is a PDF name reference (represented as a constant C string) and, if so, retrieves that name.
- CGPDFArrayGetNull:

Returns whether an object at a given index in a Quartz PDF array is a PDF null.
- CGPDFArrayGetNumber:

Returns whether an object at a given index in a PDF array is a PDF number and, if so, retrieves that object.
- CGPDFArrayGetObject:

Returns whether an object at a given index in a PDF array is a PDF object and, if so, retrieves that object.
- CGPDFArrayGetStream:

Returns whether an object at a given index in a PDF array is a PDF stream and, if so, retrieves that stream.
- CGPDFArrayGetString:

Returns whether an object at a given index in a PDF array is a PDF string and, if so, retrieves that string.
- CGPDFContentStreamCreateWithPage:

Creates a content stream object from a PDF page object.
- CGPDFContentStreamCreateWithStream:

Creates a PDF content stream object from an existing PDF content stream object.
- CGPDFContentStreamGetResource:

Gets the specified resource from a PDF content stream object.
- CGPDFContentStreamGetStreams:

Gets the array of PDF content streams contained in a PDF content stream object.
- CGPDFContentStreamRelease:

Decrements the retain count of a PDF content stream object.
- CGPDFContentStreamRetain:

Increments the retain count of a PDF content stream object.
- CGPDFContextAddDestinationAtPoint:

Sets a destination to jump to when a point in the current page of a PDF graphics context is clicked.
- CGPDFContextAddDocumentMetadata:

Associates custom metadata with the PDF document.
- CGPDFContextBeginPage:

Begins a new page in a PDF graphics context.
- CGPDFContextClose:

Closes a PDF document.
- CGPDFContextCreate:

Creates a PDF graphics context.
- CGPDFContextCreateWithURL:

Creates a URL-based PDF graphics context.
- CGPDFContextEndPage:

Ends the current page in the PDF graphics context.
- CGPDFContextSetDestinationForRect:

Sets a destination to jump to when a rectangle in the current PDF page is clicked.
- CGPDFContextSetURLForRect:

Sets the URL associated with a rectangle in a PDF graphics context.
- CGPDFDictionaryApplyFunction:

Applies a function to each entry in a dictionary.
- CGPDFDictionaryGetArray:

Returns whether there is a PDF array associated with a specified key in a PDF dictionary and, if so, retrieves that array.
- CGPDFDictionaryGetBoolean:

Returns whether there is a PDF Boolean value associated with a specified key in a PDF dictionary and, if so, retrieves the Boolean value.
- CGPDFDictionaryGetCount:

Returns the number of entries in a PDF dictionary.
- CGPDFDictionaryGetDictionary:

Returns whether there is another PDF dictionary associated with a specified key in a PDF dictionary and, if so, retrieves that dictionary.
- CGPDFDictionaryGetInteger:

Returns whether there is a PDF integer associated with a specified key in a PDF dictionary and, if so, retrieves that integer.
- CGPDFDictionaryGetName:

Returns whether an object with a specified key in a PDF dictionary is a PDF name reference (represented as a constant C string) and, if so, retrieves that name.
- CGPDFDictionaryGetNumber:

Returns whether there is a PDF number associated with a specified key in a PDF dictionary and, if so, retrieves that number.
- CGPDFDictionaryGetObject:

Returns whether there is a PDF object associated with a specified key in a PDF dictionary and, if so, retrieves that object.
- CGPDFDictionaryGetStream:

Returns whether there is a PDF stream associated with a specified key in a PDF dictionary and, if so, retrieves that stream.
- CGPDFDictionaryGetString:

Returns whether there is a PDF string associated with a specified key in a PDF dictionary and, if so, retrieves that string.
- CGPDFDocumentAllowsCopying:

Returns whether the specified PDF document allows copying.
- CGPDFDocumentAllowsPrinting:

Returns whether a PDF document allows printing.
- CGPDFDocumentCreateWithProvider:

Creates a Quartz PDF document using a data provider.
- CGPDFDocumentCreateWithURL:

Creates a Quartz PDF document using data specified by a URL.
- CGPDFDocumentGetCatalog:

Returns the document catalog of a Quartz PDF document.
- CGPDFDocumentGetID:

Gets the file identifier for a PDF document.
- CGPDFDocumentGetInfo:

Gets the information dictionary for a PDF document.
- CGPDFDocumentGetNumberOfPages:

Returns the number of pages in a PDF document.
- CGPDFDocumentGetPage:

Returns a page from a Quartz PDF document.
- CGPDFDocumentGetTypeID

Returns the type identifier for Quartz PDF documents.
- CGPDFDocumentGetVersion:

Returns the major and minor version numbers of a Quartz PDF document.
- CGPDFDocumentIsEncrypted:

Returns whether the specified PDF file is encrypted.
- CGPDFDocumentIsUnlocked:

Returns whether the specified PDF document is currently unlocked.
- CGPDFDocumentRelease:

Decrements the retain count of a PDF document.
- CGPDFDocumentRetain:

Increments the retain count of a Quartz PDF document.
- CGPDFDocumentUnlockWithPassword:

Unlocks an encrypted PDF document, if a valid password is supplied.
- CGPDFObjectGetType:

Returns the PDF type identifier of an object.
- CGPDFObjectGetValue:

Returns whether an object is of a given type and if it is, retrieves its value.
- CGPDFOperatorTableCreate

Creates an empty PDF operator table.
- CGPDFOperatorTableRelease:

Decrements the retain count of a CGPDFOperatorTable object.
- CGPDFOperatorTableRetain:

Increments the retain count of a CGPDFOperatorTable object.
- CGPDFOperatorTableSetCallback:

Sets a callback function for a PDF operator.
- CGPDFPageGetBoxRect:

Returns the rectangle that represents a type of box for a content region or page dimensions of a PDF page.
- CGPDFPageGetDictionary:

Returns the dictionary of a PDF page.
- CGPDFPageGetDocument:

Returns the document for a page.
- CGPDFPageGetDrawingTransform:

Returns the affine transform that maps a box to a given rectangle on a PDF page.
- CGPDFPageGetPageNumber:

Returns the page number of the specified PDF page.
- CGPDFPageGetRotationAngle:

Returns the rotation angle of a PDF page.
- CGPDFPageGetTypeID

Returns the CFType ID for PDF page objects.
- CGPDFPageRelease:

Decrements the retain count of a PDF page.
- CGPDFPageRetain:

Increments the retain count of a PDF page.
- CGPDFScannerCreate:

Creates a PDF scanner.
- CGPDFScannerGetContentStream:

Returns the content stream associated with a PDF scanner object.
- CGPDFScannerPopArray:

Retrieves an array object from the scanner stack.
- CGPDFScannerPopBoolean:

Retrieves a Boolean object from the scanner stack.
- CGPDFScannerPopDictionary:

Retrieves a PDF dictionary object from the scanner stack.
- CGPDFScannerPopInteger:

Retrieves an integer object from the scanner stack.
- CGPDFScannerPopName:

Retrieves a character string from the scanner stack.
- CGPDFScannerPopNumber:

Retrieves a real value object from the scanner stack.
- CGPDFScannerPopObject:

Retrieves an object from the scanner stack.
- CGPDFScannerPopStream:

Retrieves a PDF stream object from the scanner stack.
- CGPDFScannerPopString:

Retrieves a string object from the scanner stack.
- CGPDFScannerRelease:

Decrements the retain count of a scanner object.
- CGPDFScannerRetain:

Increments the retain count of a scanner object.
- CGPDFScannerScan:

Parses the content stream of a PDF scanner object.
- CGPDFStreamCopyData:

Returns the data associated with a PDF stream.
- CGPDFStreamGetDictionary:

Returns the dictionary associated with a PDF stream.
- CGPDFStringCopyDate:

Converts a string to a date.
- CGPDFStringCopyTextString:

Returns a CFString object that represents a PDF string as a text string.
- CGPDFStringGetBytePtr:

Returns a pointer to the bytes of a PDF string.
- CGPDFStringGetLength:

Returns the number of bytes in a PDF string.
- CGPointApplyAffineTransform:

Returns the point resulting from an affine transformation of an existing point.
- CGPointCreateDictionaryRepresentation:

Returns a dictionary representation of the specified point.
- CGPointEqualToPoint:

Returns whether two points are equal.
- CGPointFromString:

Returns a Core Graphics point structure corresponding to the data in a given string.
- CGPointMake:

Returns a point with the specified coordinates.
- CGPointMakeWithDictionaryRepresentation:

Fills in a point using the contents of the specified dictionary.
- CGRectApplyAffineTransform:

Applies an affine transform to a rectangle.
- CGRectContainsPoint:

Returns whether a rectangle contains a specified point.
- CGRectContainsRect:

Returns whether the first rectangle contains the second rectangle.
- CGRectCreateDictionaryRepresentation:

Returns a dictionary representation of the provided rectangle.
- CGRectDivide:

Divides a source rectangle into two component rectangles.
- CGRectEqualToRect:

Returns whether two rectangles are equal in size and position.
- CGRectFromString:

Returns a Core Graphics rectangle structure corresponding to the data in a given string.
- CGRectGetHeight:

Returns the height of a rectangle.
- CGRectGetMaxX:

Returns the x-coordinate that establishes the right edge of a rectangle.
- CGRectGetMaxY:

Returns the y-coordinate that establishes the top edge of a rectangle.
- CGRectGetMidX:

Returns the x- coordinate that establishes the center of a rectangle.
- CGRectGetMidY:

Returns the y-coordinate that establishes the center of a rectangle.
- CGRectGetMinX:

Returns the x-coordinate that establishes the left edge of a rectangle.
- CGRectGetMinY:

Returns the y-coordinate that establishes the bottom edge of a rectangle.
- CGRectGetWidth:

Returns the width of a rectangle.
- CGRectInset:

Returns a rectangle that is smaller or larger than the source rectangle, with the same center point.
- CGRectIntegral:

Returns the smallest rectangle that results from converting the source rectangle values to integers.
- CGRectIntersection:

Returns the intersection of two rectangles.
- CGRectIntersectsRect:

Returns whether two rectangles intersect.
- CGRectIsEmpty:

Returns whether a rectangle has zero width or height, or is a null rectangle.
- CGRectIsInfinite:

Returns whether a rectangle is infinite.
- CGRectIsNull:

Returns whether the rectangle is equal to the null rectangle.
- CGRectMake:

Returns a rectangle with the specified coordinate and size values.
- CGRectMakeWithDictionaryRepresentation:

Fills in a rectangle using the contents of the specified dictionary.
- CGRectOffset:

Returns a rectangle with an origin that is offset from that of the source rectangle.
- CGRectStandardize:

Returns a rectangle with a positive width and height.
- CGRectUnion:

Returns the smallest rectangle that contains the two source rectangles.
- CGShadingCreateAxial:

Creates a shading object to use for axial shading.
- CGShadingCreateRadial:

Creates a shading object to use for radial shading.
- CGShadingGetTypeID

Returns the Core Foundation type identifier for Quartz shading objects.
- CGShadingRelease:

Decrements the retain count of a shading object.
- CGShadingRetain:

Increments the retain count of a shading object.
- CGSizeApplyAffineTransform:

Returns the height and width resulting from a transformation of an existing height and width.
- CGSizeCreateDictionaryRepresentation:

Returns a dictionary representation of the specified size.
- CGSizeEqualToSize:

Returns whether two sizes are equal.
- CGSizeFromString:

Returns a Core Graphics size structure corresponding to the data in a given string.
- CGSizeMake:

Returns a size with the specified dimension values.
- CGSizeMakeWithDictionaryRepresentation:

Fills in a size using the contents of the specified dictionary.
- CVBufferGetAttachment:

Returns a specific attachment of a Core Video buffer.
- CVBufferGetAttachments:

Returns all attachments of a Core Video buffer.
- CVBufferPropagateAttachments:

Copies all attachments that can be propagated from one Core Video buffer to another.
- CVBufferRelease:

Releases a Core Video buffer.
- CVBufferRemoveAllAttachments:

Removes all attachments of a Core Video buffer.
- CVBufferRemoveAttachment:

Removes a specific attachment of a Core Video buffer.
- CVBufferRetain:

Retains a Core Video buffer.
- CVBufferSetAttachment:

Sets or adds an attachment of a Core Video buffer.
- CVBufferSetAttachments:

Sets a set of attachments for a Core Video buffer.
- CVImageBufferGetCleanRect:

Returns the source rectangle of a Core Video image buffer that represents the clean aperture of the buffer in encoded pixels.
- CVImageBufferGetDisplaySize:

Returns the nominal output display size, in square pixels, of a Core Video image buffer.
- CVImageBufferGetEncodedSize:

Returns the full encoded dimensions of a Core Video image buffer.
- CVPixelBufferCreate:

Creates a single pixel buffer for a given size and pixel format.
- CVPixelBufferCreateResolvedAttributesDictionary:

Takes an array of CFDictionary objects describing various pixel buffer attributes and tries to resolve them into a single dictionary.
- CVPixelBufferCreateWithBytes:

Creates a pixel buffer for a given size and pixel format containing data specified by a memory location.
- CVPixelBufferCreateWithPlanarBytes:

Creates a single pixel buffer in planar format for a given size and pixel format containing data specified by a memory location.
- CVPixelBufferFillExtendedPixels:

Fills the extended pixels of the pixel buffer.
- CVPixelBufferGetBaseAddress:

Returns the base address of the pixel buffer.
- CVPixelBufferGetBaseAddressOfPlane:

Returns the base address of the plane at the specified plane index.
- CVPixelBufferGetBytesPerRow:

Returns the number of bytes per row of the pixel buffer.
- CVPixelBufferGetBytesPerRowOfPlane:

Returns the number of bytes per row for a plane at the specified index in the pixel buffer.
- CVPixelBufferGetDataSize:

Returns the data size for contiguous planes of the pixel buffer.
- CVPixelBufferGetExtendedPixels:

Returns the amount of extended pixel padding in the pixel buffer.
- CVPixelBufferGetHeight:

Returns the height of the pixel buffer.
- CVPixelBufferGetHeightOfPlane:

Returns the height of the plane at planeIndex in the pixel buffer.
- CVPixelBufferGetPixelFormatType:

Returns the pixel format type of the pixel buffer.
- CVPixelBufferGetPlaneCount:

Returns number of planes of the pixel buffer.
- CVPixelBufferGetTypeID

Returns the Core Foundation ID of the pixel buffer type.
- CVPixelBufferGetWidth:

Returns the width of the pixel buffer.
- CVPixelBufferGetWidthOfPlane:

Returns the width of the plane at a given index in the pixel buffer.
- CVPixelBufferIsPlanar:

Determines whether the pixel buffer is planar.
- CVPixelBufferLockBaseAddress:

Locks the base address of the pixel buffer.
- CVPixelBufferPoolCreate:

Creates a pixel buffer pool.
- CVPixelBufferPoolCreatePixelBuffer:

Creates a pixel buffer from a pixel buffer pool.
- CVPixelBufferPoolGetAttributes:

Returns the pool attributes dictionary for a pixel buffer pool.
- CVPixelBufferPoolGetPixelBufferAttributes:

Returns the attributes of pixel buffers that will be created from this pool.
- CVPixelBufferPoolGetTypeID

Returns the Core Foundation ID of the pixel buffer pool type.
- CVPixelBufferPoolRelease:

Releases a pixel buffer pool.
- CVPixelBufferPoolRetain:

Retains a pixel buffer pool.
- CVPixelBufferRelease:

Releases a pixel buffer.
- CVPixelBufferRetain:

Retains a pixel buffer.
- CVPixelBufferUnlockBaseAddress:

Unlocks the base address of the pixel buffer.
- CVPixelFormatDescriptionArrayCreateWithAllPixelFormatTypes:

Returns all the pixel format descriptions known to Core Video.
- CVPixelFormatDescriptionCreateWithPixelFormatType:

Creates a pixel format description from a given OSType identifier.
- CVPixelFormatDescriptionRegisterDescriptionWithPixelFormatType:

Registers a pixel format description with Core Video.
- getParagraphStart:end:contentsEnd:forRange:

Returns by reference the beginning of the first paragraph and the end of the last paragraph touched by the given range.
- hash

Returns an unsigned integer that can be used as a hash table address.
- hasPrefix:

Returns a Boolean value that indicates whether a given string matches the beginning characters of the receiver.
- hasSuffix:

Returns a Boolean value that indicates whether a given string matches the ending characters of the receiver.
- init

Returns an initialized NSString object that contains no characters.
- initRecurrenceWithFrequency:interval:end:

Initializes and returns a simple recurrence rule with a given frequency, interval, and end.
- initWithBytes:length:encoding:

Returns an initialized NSString object containing a given number of bytes from a given buffer of bytes interpreted in a given encoding.
- initWithBytesNoCopy:length:encoding:freeWhenDone:

Returns an initialized NSString object that contains a given number of bytes from a given buffer of bytes interpreted in a given encoding, and optionally frees the buffer.
- initWithCharacters:length:

Returns an initialized NSString object that contains a given number of characters from a given C array of Unicode characters.
- initWithCharactersNoCopy:length:freeWhenDone:

Returns an initialized NSString object that contains a given number of characters from a given C array of Unicode characters.
- initWithContentsOfFile:encoding:error:

Returns an NSString object initialized by reading data from the file at a given path using a given encoding.
- initWithContentsOfFile:usedEncoding:error:

Returns an NSString object initialized by reading data from the file at a given path and returns by reference the encoding used to interpret the characters.
- initWithContentsOfURL:encoding:error:

Returns an NSString object initialized by reading data from a given URL interpreted using a given encoding.
- initWithContentsOfURL:usedEncoding:error:

Returns an NSString object initialized by reading data from a given URL and returns by reference the encoding used to interpret the data.
- initWithCString:encoding:

Returns an NSString object initialized using the characters in a given C array, interpreted according to a given encoding.
- initWithData:encoding:

Returns an NSString object initialized by converting given data into Unicode characters using a given encoding.
- initWithFormat:

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted.
- initWithFormat:arguments:

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted according to the user’s default locale.
- initWithFormat:locale:

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted according to given locale information.
- initWithFormat:locale:arguments:

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted according to given locale information.
- initWithString:

Returns an NSString object initialized by copying the characters from another given string.
- initWithUTF8String:

Returns an NSString object initialized by copying the characters a given C array of UTF8-encoded bytes.
- integerValue

Returns the NSInteger value of the receiver’s text.
- intValue

Returns the integer value of the receiver’s text.
- isAbsolutePath

Returning a Boolean value that indicates whether the receiver represents an absolute path.
- isEqualToString:

Returns a Boolean value that indicates whether a given string is equal to the receiver using a literal Unicode-based comparison.
- lastPathComponent

Returns the last path component of the receiver.
- length

Returns the number of Unicode characters in the receiver.
- lengthOfBytesUsingEncoding:

Returns the number of bytes required to store the receiver in a given encoding.
- lineRangeForRange:

Returns the range of characters representing the line or lines containing a given range.
- linguisticTagsInRange:scheme:options:orthography:tokenRanges:

Returns an array of linguistic tags for the specified range and requested tags within the receiving string.
- localizedCaseInsensitiveCompare:

Returns an NSComparisonResult value that indicates the lexical ordering of the receiver and a given string using a case-insensitive, localized, comparison.
- localizedCompare:

Returns an NSComparisonResult value that indicates the lexical ordering of the receiver and another given string using a localized comparison.
- localizedStandardCompare:

Compares strings as sorted by the Finder.
- longLongValue

Returns the long long value of the receiver’s text.
- lowercaseString

Returns lowercased representation of the receiver.
- lowercaseStringWithLocale:

Returns lowercased representation of the receiver with the specified locale.
- maximumLengthOfBytesUsingEncoding:

Returns the maximum number of bytes needed to store the receiver in a given encoding.
- MKCoordinateForMapPoint:

Returns the latitude and longitude that corresponds to the specified map point.
- MKCoordinateRegionForMapRect:

Returns the region that corresponds to the specified map rectangle.
- MKCoordinateRegionMake:

Creates a new MKCoordinateRegion from the specified coordinate and span values.
- MKCoordinateRegionMakeWithDistance:

Creates a new MKCoordinateRegion from the specified coordinate and distance values.
- MKCoordinateSpanMake:

Creates a new MKCoordinateSpan from the specified values.
- MKMapPointEqualToPoint:

Returns a Boolean value indicating whether the two map points are equal.
- MKMapPointForCoordinate:

Returns the map point data structure that corresponds to the specified coordinate.
- MKMapPointMake:

Creates a new MKMapPoint structure from the specified values.
- MKMapPointsPerMeterAtLatitude:

Returns the number of map points that represent one meter at the given latitude.
- MKMapRectContainsPoint:

Returns a Boolean value indicating whether the specified map point lies within the rectangle.
- MKMapRectContainsRect:

Returns Boolean value indicating whether one rectangle contains another.
- MKMapRectDivide:

Divides the specified rectangle into two smaller rectangles.
- MKMapRectEqualToRect:

Returns a Boolean value indicating whether the two map rectangles are equal.
- MKMapRectGetHeight:

Returns the height of the map rectangle.
- MKMapRectGetMaxX:

Returns the maximum x-axis value of the specified rectangle.
- MKMapRectGetMaxY:

Returns the maximum y-axis value of the specified rectangle.
- MKMapRectGetMidX:

Returns the mid-point along the x-axis of the specified rectangle.
- MKMapRectGetMidY:

Returns the mid-point along the y-axis of the specified rectangle.
- MKMapRectGetMinX:

Returns the minimum x-axis value of the specified rectangle.
- MKMapRectGetMinY:

Returns the minimum y-axis value of the specified rectangle.
- MKMapRectGetWidth:

Returns the width of the map rectangle.
- MKMapRectInset:

Returns the specified rectangle inset by the specified amounts.
- MKMapRectIntersection:

Returns the rectangle representing the intersection of two rectangles.
- MKMapRectIntersectsRect:

Returns a Boolean value indicating whether two rectangles intersect each other.
- MKMapRectIsEmpty:

Returns a Boolean value indicating whether the specified rectangle has no area.
- MKMapRectIsNull:

Returns a Boolean indicating whether the specified rectangle is null.
- MKMapRectMake:

Creates a new MKMapRect structure from the specified values.
- MKMapRectOffset:

Returns a rectangle whose origin point is shifted by the specified amount.
- MKMapRectRemainder:

Normalizes the portion of the specified rectangle that lies outside the world map boundaries.
- MKMapRectSpans180thMeridian:

Returns a Boolean value that indicates whether the specified map rectangle crosses the 180th meridian.
- MKMapRectUnion:

Returns a rectangle representing the union of the two rectangles.
- MKMapSizeEqualToSize:

Returns a Boolean value indicating whether the two map sizes are equal.
- MKMapSizeMake:

Creates a new MKMapSize structure from the specified values.
- MKMetersBetweenMapPoints:

Returns the number of meters between two map points.
- MKMetersPerMapPointAtLatitude:

Returns the distance spanned by one map point at the specified latitude.
- MKRoadWidthAtZoomScale:

Returns the width (in screen points) of roads on a map at the specified zoom level.
- MKStringFromMapPoint:

Returns a formatted string for the specified map point.
- MKStringFromMapRect:

Returns a formatted string for the specified map rectangle.
- MKStringFromMapSize:

Returns a formatted string for the specified map size.
- NSAllocateMemoryPages:

Allocates a new block of memory.
- NSAllocateObject:

Creates and returns a new instance of a given class.
- NSClassFromString:

Obtains a class by name.
- NSConvertHostDoubleToSwapped:

Performs a type conversion.
- NSConvertHostFloatToSwapped:

Performs a type conversion.
- NSConvertSwappedDoubleToHost:

Performs a type conversion.
- NSConvertSwappedFloatToHost:

Performs a type conversion.
- NSCopyMemoryPages:

Copies a block of memory.
- NSCopyObject:

Creates an exact copy of an object.
- NSCreateZone:

Creates a new zone.
- NSDeallocateMemoryPages:

Deallocates the specified block of memory.
- NSDeallocateObject:

Destroys an existing object.
- NSDecimalAdd:

Adds two decimal values.
- NSDecimalCompact:

Compacts the decimal structure for efficiency.
- NSDecimalCompare:

Compares two decimal values.
- NSDecimalCopy:

Copies the value of a decimal number.
- NSDecimalDivide:

Divides one decimal value by another.
- NSDecimalIsNotANumber:

Returns a Boolean that indicates whether a given decimal contains a valid number.
- NSDecimalMultiply:

Multiplies two decimal numbers together.
- NSDecimalMultiplyByPowerOf10:

Multiplies a decimal by the specified power of 10.
- NSDecimalNormalize:

Normalizes the internal format of two decimal numbers to simplify later operations.
- NSDecimalPower:

Raises the decimal value to the specified power.
- NSDecimalRound:

Rounds off the decimal value.
- NSDecimalString:

Returns a string representation of the decimal value.
- NSDecimalSubtract:

Subtracts one decimal value from another.
- NSDecrementExtraRefCountWasZero:

Decrements the specified object’s reference count.
- NSDefaultMallocZone

Returns the default zone.
- NSEqualRanges:

Returns a Boolean value that indicates whether two given ranges are equal.
- NSExtraRefCount:

Returns the specified object’s reference count.
- NSFullUserName

Returns a string containing the full name of the current user.
- NSGetSizeAndAlignment:

Obtains the actual size and the aligned size of an encoded type.
- NSGetUncaughtExceptionHandler

Returns the top-level error handler.
- NSHomeDirectory

Returns the path to either the user’s or application’s home directory, depending on the platform.
- NSHomeDirectoryForUser:

Returns the path to a given user’s home directory.
- NSHostByteOrder

Returns the endian format.
- NSIncrementExtraRefCount:

Increments the specified object’s reference count.
- NSIntersectionRange:

Returns the intersection of the specified ranges.
- NSLocationInRange:

Returns a Boolean value that indicates whether a specified position is in a given range.
- NSLog:

Logs an error message to the Apple System Log facility.
- NSLogPageSize

Returns the binary log of the page size.
- NSLogv:

Logs an error message to the Apple System Log facility.
- NSMakeRange:

Creates a new NSRange from the specified values.
- NSMaxRange:

Returns the sum of the location and length of the range.
- NSOpenStepRootDirectory

Returns the root directory of the user’s system.
- NSPageSize

Returns the number of bytes in a page.
- NSProtocolFromString:

Returns a the protocol with a given name.
- NSRangeFromString:

Returns a range from a textual representation.
- NSRealMemoryAvailable

Returns information about the user’s system.
- NSRecycleZone:

Frees memory in a zone.
- NSRoundDownToMultipleOfPageSize:

Returns the specified number of bytes rounded down to a multiple of the page size.
- NSRoundUpToMultipleOfPageSize:

Returns the specified number of bytes rounded up to a multiple of the page size.
- NSSearchPathForDirectoriesInDomains:

Creates a list of directory search paths.
- NSSelectorFromString:

Returns the selector with a given name.
- NSSetUncaughtExceptionHandler

Changes the top-level error handler.
- NSSetZoneName:

Sets the name of the specified zone.
- NSShouldRetainWithZone:

Indicates whether an object should be retained.
- NSStringFromCGAffineTransform:

Returns a string formatted to contain the data from an affine transform.
- NSStringFromCGPoint:

Returns a string formatted to contain the data from a point.
- NSStringFromCGRect:

Returns a string formatted to contain the data from a rectangle.
- NSStringFromCGSize:

Returns a string formatted to contain the data from a size data structure.
- NSStringFromClass:

Returns the name of a class as a string.
- NSStringFromProtocol:

Returns the name of a protocol as a string.
- NSStringFromRange:

Returns a string representation of a range.
- NSStringFromSelector:

Returns a string representation of a given selector.
- NSStringFromUIEdgeInsets:

Returns a string formatted to contain the data from an edge insets structure.
- NSStringFromUIOffset:

Returns a string formatted to contain the data from an offset structure.
- NSSwapBigDoubleToHost:

A utility for swapping the bytes of a number.
- NSSwapBigFloatToHost:

A utility for swapping the bytes of a number.
- NSSwapBigIntToHost:

A utility for swapping the bytes of a number.
- NSSwapBigLongLongToHost:

A utility for swapping the bytes of a number.
- NSSwapBigLongToHost:

A utility for swapping the bytes of a number.
- NSSwapBigShortToHost:

A utility for swapping the bytes of a number.
- NSSwapDouble:

A utility for swapping the bytes of a number.
- NSSwapFloat:

A utility for swapping the bytes of a number.
- NSSwapHostDoubleToBig:

A utility for swapping the bytes of a number.
- NSSwapHostDoubleToLittle:

A utility for swapping the bytes of a number.
- NSSwapHostFloatToBig:

A utility for swapping the bytes of a number.
- NSSwapHostFloatToLittle:

A utility for swapping the bytes of a number.
- NSSwapHostIntToBig:

A utility for swapping the bytes of a number.
- NSSwapHostIntToLittle:

A utility for swapping the bytes of a number.
- NSSwapHostLongLongToBig:

A utility for swapping the bytes of a number.
- NSSwapHostLongLongToLittle:

A utility for swapping the bytes of a number.
- NSSwapHostLongToBig:

A utility for swapping the bytes of a number.
- NSSwapHostLongToLittle:

A utility for swapping the bytes of a number.
- NSSwapHostShortToBig:

A utility for swapping the bytes of a number.
- NSSwapHostShortToLittle:

A utility for swapping the bytes of a number.
- NSSwapInt:

A utility for swapping the bytes of a number.
- NSSwapLittleDoubleToHost:

A utility for swapping the bytes of a number.
- NSSwapLittleFloatToHost:

A utility for swapping the bytes of a number.
- NSSwapLittleIntToHost:

A utility for swapping the bytes of a number.
- NSSwapLittleLongLongToHost:

A utility for swapping the bytes of a number.
- NSSwapLittleLongToHost:

A utility for swapping the bytes of a number.
- NSSwapLittleShortToHost:

A utility for swapping the bytes of a number.
- NSSwapLong:

A utility for swapping the bytes of a number.
- NSSwapLongLong:

A utility for swapping the bytes of a number.
- NSSwapShort:

A utility for swapping the bytes of a number.
- NSTemporaryDirectory

Returns the path of the temporary directory for the current user.
- NSTextAlignmentFromCTTextAlignment:

Converts a Core Text alignment constant value to the matching constant value used by UIKit.
- NSTextAlignmentToCTTextAlignment:

Converts a UIKit text alignment constant value to the matching constant value used by Core Text.
- NSUnionRange:

Returns the union of the specified ranges.
- NSUserName

Returns the logon name of the current user.
- NSZoneCalloc:

Allocates memory in a zone.
- NSZoneFree:

Deallocates a block of memory in the specified zone.
- NSZoneFromPointer:

Gets the zone for a given block of memory.
- NSZoneMalloc:

Allocates memory in a zone.
- NSZoneName:

Returns the name of the specified zone.
- NSZoneRealloc:

Allocates memory in a zone.
- paragraphRangeForRange:

Returns the range of characters representing the paragraph or paragraphs containing a given range.
- pathComponents

Returns an array of NSString objects containing, in order, each path component of the receiver.
- pathExtension

Interprets the receiver as a path and returns the receiver’s extension, if any.
- performBlockAndWait:
- persistentStoreCoordinator

Returns the persistent store coordinator of the receiver.
- precomposedStringWithCanonicalMapping

Returns a string made by normalizing the receiver’s contents using Form C.
- precomposedStringWithCompatibilityMapping

Returns a string made by normalizing the receiver’s contents using Form KC.
- processPendingChanges

Forces the receiver to process changes to the object graph.
- propagatesDeletesAtEndOfEvent

Returns a Boolean that indicates whether the receiver propagates deletes at the end of the event in which a change was made.
- propertyList

Parses the receiver as a text representation of a property list, returning an NSString, NSData, NSArray, or NSDictionary object, according to the topmost element.
- propertyListFromStringsFileFormat

Returns a dictionary object initialized with the keys and values found in the receiver.
- rangeOfCharacterFromSet:

Finds and returns the range in the receiver of the first character from a given character set.
- rangeOfCharacterFromSet:options:

Finds and returns the range in the receiver of the first character, using given options, from a given character set.
- rangeOfCharacterFromSet:options:range:

Finds and returns the range in the receiver of the first character from a given character set found in a given range with given options.
- rangeOfComposedCharacterSequenceAtIndex:

Returns the range in the receiver of the composed character sequence located at a given index.
- rangeOfComposedCharacterSequencesForRange:

Returns the range in the string of the composed character sequences for a given range.
- rangeOfString:

Finds and returns the range of the first occurrence of a given string within the receiver.
- rangeOfString:options:

Finds and returns the range of the first occurrence of a given string within the receiver, subject to given options.
- rangeOfString:options:range:

Finds and returns the range of the first occurrence of a given string, within the given range of the receiver, subject to given options.
- rangeOfString:options:range:locale:

Finds and returns the range of the first occurrence of a given string within a given range of the receiver, subject to given options, using the specified locale, if any.
- redo

Sends an redo message to the receiver’s undo manager, asking it to reverse the latest undo operation applied to objects in the object graph.
- refreshObject:mergeChanges:

Updates the persistent properties of a managed object to use the latest values from the persistent store.
- registeredObjects

Returns the set of objects registered with the receiver.
- reset

Returns the receiver to its base state.
- retainsRegisteredObjects

Returns a Boolean that indicates whether the receiver keeps strong references to all registered managed objects.
- rollback

Removes everything from the undo stack, discards all insertions and deletions, and restores updated objects to their last committed values.
- save:

Attempts to commit unsaved changes to registered objects to their persistent store.
- sendDataToAllPlayers:withDataMode:error:

Transmits data to all players connected to the match.
- setMergePolicy:

Sets the merge policy of the receiver.
- setParentContext:

Sets the receiver’s parent context to the given context.
- setPersistentStoreCoordinator:

Sets the persistent store coordinator of the receiver.
- setPropagatesDeletesAtEndOfEvent:

Sets whether the context propagates deletes to related objects at the end of the event.
- setRetainsRegisteredObjects:

Sets whether the receiver keeps strong references to all registered managed objects, or only objects necessary for a pending save (those that are inserted, updated, deleted, or locked).
- setStalenessInterval:

Sets the maximum length of time that may have elapsed since the store previously fetched data before fulfilling a fault issues a new fetch rather than using the previously-fetched data.
- setUndoManager:

Sets the undo manager of the receiver.
- smallestEncoding

Returns the smallest encoding to which the receiver can be converted without loss of information.
- stalenessInterval

Returns the maximum length of time that may have elapsed since the store previously fetched data before fulfilling a fault issues a new fetch rather than using the previously-fetched data.
- stringByAbbreviatingWithTildeInPath

Returns a new string representing the receiver as a path with a tilde (~) substituted for the full path to the current user’s home directory.
- stringByAddingPercentEscapesUsingEncoding:

Returns a representation of the receiver using a given encoding to determine the percent escapes necessary to convert the receiver into a legal URL string.
- stringByAppendingFormat:

Returns a string made by appending to the receiver a string constructed from a given format string and the following arguments.
- stringByAppendingPathComponent:

Returns a new string made by appending to the receiver a given string.
- stringByAppendingPathExtension:

Returns a new string made by appending to the receiver an extension separator followed by a given extension.
- stringByAppendingString:

Returns a new string made by appending a given string to the receiver.
- stringByDeletingLastPathComponent

Returns a new string made by deleting the last path component from the receiver, along with any final path separator.
- stringByDeletingPathExtension

Returns a new string made by deleting the extension (if any, and only the last) from the receiver.
- stringByExpandingTildeInPath

Returns a new string made by expanding the initial component of the receiver to its full path value.
- stringByFoldingWithOptions:locale:

Returns a string with the given character folding options applied.
- stringByPaddingToLength:withString:startingAtIndex:

Returns a new string formed from the receiver by either removing characters from the end, or by appending as many occurrences as necessary of a given pad string.
- stringByReplacingCharactersInRange:withString:

Returns a new string in which the characters in a specified range of the receiver are replaced by a given string.
- stringByReplacingOccurrencesOfString:withString:

Returns a new string in which all occurrences of a target string in the receiver are replaced by another given string.
- stringByReplacingOccurrencesOfString:withString:options:range:

Returns a new string in which all occurrences of a target string in a specified range of the receiver are replaced by another given string.
- stringByReplacingPercentEscapesUsingEncoding:

Returns a new string made by replacing in the receiver all percent escapes with the matching characters as determined by a given encoding.
- stringByResolvingSymlinksInPath

Returns a new string made from the receiver by resolving all symbolic links and standardizing path.
- stringByStandardizingPath

Returns a new string made by removing extraneous path components from the receiver.
- stringByTrimmingCharactersInSet:

Returns a new string made by removing from both ends of the receiver characters contained in a given character set.
- stringsByAppendingPaths:

Returns an array of strings made by separately appending to the receiver each string in in a given array.
- substringFromIndex:

Returns a new string containing the characters of the receiver from the one at a given index to the end.
- substringToIndex:

Returns a new string containing the characters of the receiver up to, but not including, the one at a given index.
- substringWithRange:

Returns a string object containing the characters of the receiver that lie within a given range.
- tryLock

Attempts to acquire a lock.
- UIAccessibilityPostNotification:

Posts a notification to assistive applications.
- UIAccessibilityZoomFocusChanged:

Notifies the system that the app’s focus has changed to a new location.
- UIApplicationMain:

This function is called in the main entry point to create the application object and the application delegate and set up the event cycle.
- UIEdgeInsetsEqualToEdgeInsets:

Compares two edge insets to determine if they are the same.
- UIEdgeInsetsFromString:

Returns a UIKit edge insets structure corresponding to the data in a given string.
- UIEdgeInsetsInsetRect:

Adjusts a rectangle by the given edge insets.
- UIEdgeInsetsMake:

Creates an edge inset for a button or view.
- UIGraphicsAddPDFContextDestinationAtPoint:

Creates a jump destination in the current page.
- UIGraphicsBeginImageContext:

Creates a bitmap-based graphics context and makes it the current context.
- UIGraphicsBeginImageContextWithOptions:

Creates a bitmap-based graphics context with the specified options.
- UIGraphicsBeginPDFContextToData:

Creates a PDF-based graphics context that targets the specified mutable data object.
- UIGraphicsBeginPDFContextToFile:

Creates a PDF-based graphics context that targets a file at the specified path.
- UIGraphicsBeginPDFPage

Marks the beginning of a new page in a PDF context and configures it using default values.
- UIGraphicsBeginPDFPageWithInfo:

Marks the beginning of a new page in a PDF context and configures it using the specified values.
- UIGraphicsEndImageContext

Removes the current bitmap-based graphics context from the top of the stack.
- UIGraphicsEndPDFContext

Closes a PDF graphics context and pops it from the current context stack.
- UIGraphicsGetCurrentContext

Returns the current graphics context.
- UIGraphicsGetImageFromCurrentImageContext

Returns an image based on the contents of the current bitmap-based graphics context.
- UIGraphicsGetPDFContextBounds

Returns the current page bounds.
- UIGraphicsPopContext

Removes the current graphics context from the top of the stack, restoring the previous context.
- UIGraphicsPushContext:

Makes the specified graphics context the current context.
- UIGraphicsSetPDFContextDestinationForRect:

Links a rectangle on the current page to the specified jump destination.
- UIGraphicsSetPDFContextURLForRect:

Links a rectangle on the current page to the specified URL.
- UIImageJPEGRepresentation:

Returns the data for the specified image in JPEG format.
- UIImagePNGRepresentation:

Returns the data for the specified image in PNG format.
- UIImageWriteToSavedPhotosAlbum:

Adds the specified image to the user’s Camera Roll album.
- UIOffsetFromString:

Returns a UIKit offset structure corresponding to the data in a given string.
- UIRectClip:

Modifies the current clipping path by intersecting it with the specified rectangle.
- UIRectFill:

Fills the specified rectangle with the current color.
- UIRectFillUsingBlendMode:

Fills a rectangle with the current fill color using the specified blend mode.
- UIRectFrame:

Draws a frame around the inside of the specified rectangle.
- UIRectFrameUsingBlendMode:

Draws a frame around the inside of a rectangle using the specified blend mode.
- UISaveVideoAtPathToSavedPhotosAlbum:

Adds the movie at the specified path to the user’s Camera Roll album.
- UIVideoAtPathIsCompatibleWithSavedPhotosAlbum:

Returns a Boolean value indicating whether the specified video can be saved to user’s Camera Roll album.
- undo

Sends an undo message to the receiver’s undo manager, asking it to reverse the latest uncommitted changes applied to objects in the object graph.
- undoManager

Returns the undo manager of the receiver.
- unlock

Relinquishes a previously acquired lock.
- updatedObjects

Returns the set of objects registered with the receiver that have uncommitted changes.
- uppercaseString

Returns an uppercased representation of the receiver.
- uppercaseStringWithLocale:

Returns uppercased representation of the receiver with the specified locale.
- userInfo

Returns the receiver’s user info.
- UTF8String

Returns a null-terminated UTF8 representation of the receiver.
- voiceChatWithName:

Joins a voice channel.
- writeToFile:atomically:encoding:error:

Writes the contents of the receiver to a file at a given path using a given encoding.
- writeToURL:atomically:encoding:error:

Writes the contents of the receiver to the URL specified by url using the specified encoding.

Instance Method Details

- (`CGRect`) AVMakeRectWithAspectRatioInsideRect(aspectRatio, boundingRect)

Returns a scaled CGRect that maintains the aspect ratio specified by a CGSize within a bounding CGRect.

Parameters:

aspectRatio (CGSize) —

The width and height ratio (aspect ratio) you want to maintain.
boundingRect (CGRect) —

The bounding rectangle you want to fit into.

Returns:

(CGRect) —

Returns a scaled CGRect that maintains the aspect ratio specified by aspectRatio that fits withinboundingRect.

- (`CFTimeInterval`) CACurrentMediaTime

Returns the current absolute time, in seconds.

Returns:

(CFTimeInterval) —

A CFTimeInterval derived by calling mach_absolute_time() and converting the result to seconds.

- (`CATransform3D`) CATransform3DConcat(a, b)

Concatenate 'b' to 'a' and return the result: t' = a * b.

Parameters:

a (CATransform3D)
b (CATransform3D)

Returns:

(CATransform3D) —

YES if a and b are exactly equal, otherwise NO.

- (`Boolean`) CATransform3DEqualToTransform(a, b)

Returns a Boolean value that indicates whether the two transforms are exactly equal.

Parameters:

a (CATransform3D)
b (CATransform3D)

Returns:

(Boolean) —

YES if t is the identity transform, otherwise NO.

- (`CGAffineTransform`) CATransform3DGetAffineTransform(t)

Returns the affine transform represented by 't'. If 't' can not be exactly represented as an affine transform the returned value is undefined.

Parameters:

t (CATransform3D)

Returns:

(CGAffineTransform)

- (`CATransform3D`) CATransform3DInvert(t)

Invert 't' and return the result. Returns the original matrix if 't' has no inverse.

Parameters:

t (CATransform3D)

Returns:

(CATransform3D)

- (`Boolean`) CATransform3DIsAffine(t)

Returns true if 't' can be exactly represented by an affine transform.

Parameters:

t (CATransform3D)

Returns:

(Boolean)

- (`Boolean`) CATransform3DIsIdentity(t)

Returns a Boolean value that indicates whether the transform is the identity transform.

Parameters:

t (CATransform3D)

Returns:

(Boolean)

- (`CATransform3D`) CATransform3DMakeRotation(angle, x, y, z)

Returns a transform that rotates by 'angle' radians about the vector '(x, y, z)'. If the vector has length zero the identity transform is returned.

Parameters:

angle (Float)
x (Float)
y (Float)
z (Float)

Returns:

(CATransform3D)

- (`CATransform3D`) CATransform3DMakeScale(sx, sy, sz)

Returns a transform that scales by `(sx, sy, sz)': * t' = [sx 0 0 0; 0 sy 0 0; 0 0 sz 0; 0 0 0 1].

Parameters:

sx (Float)
sy (Float)
sz (Float)

Returns:

(CATransform3D)

- (`CATransform3D`) CATransform3DTranslate(t, tx, ty, tz)

Translate 't' by '(tx, ty, tz)' and return the result: t' = translate(tx, ty, tz) * t.

Parameters:

t (CATransform3D)
tx (Float)
ty (Float)
tz (Float)

Returns:

(CATransform3D)

- (`CFAbsoluteTime`) CFAbsoluteTimeAddGregorianUnits(at, tz, units)

Adds a time interval, expressed as Gregorian units, to a given absolute time.

Parameters:

at (CFAbsoluteTime) —

The absolute time to which the interval is added.
tz (CFTimeZoneRef) —

The time zone to use for time correction. Pass NULL for GMT.
units (CFGregorianUnits) —

The time interval to add to at.

Returns:

(CFAbsoluteTime) —

An absolute time value equal to the sum of at and units.

- (`SInt32`) CFAbsoluteTimeGetDayOfWeek(at, tz)

Returns an integer representing the day of the week indicated by the specified absolute time.

Parameters:

at (CFAbsoluteTime) —

The absolute time to which the interval is added.
tz (CFTimeZoneRef) —

The time zone to use for time correction. Pass NULL for GMT.

Returns:

(SInt32) —

An integer (1-7) representing the day of the week specified by at. Per ISO-8601, Monday is represented by 1, Tuesday by 2, and so on.

- (`SInt32`) CFAbsoluteTimeGetDayOfYear(at, tz)

Returns an integer representing the day of the year indicated by the specified absolute time.

Parameters:

at (CFAbsoluteTime) —

The absolute time to which the interval is added.
tz (CFTimeZoneRef) —

The time zone to use for time correction. Pass NULL for GMT.

Returns:

(SInt32) —

An integer (1-366) representing the day of the year specified by at.

- (`CFGregorianUnits`) CFAbsoluteTimeGetDifferenceAsGregorianUnits(at1, at2, tz, unitFlags)

Computes the time difference between two specified absolute times and returns the result as an interval in Gregorian units.

Parameters:

at1 (CFAbsoluteTime) —

The absolute time to which the interval is added.
at2 (CFAbsoluteTime) —

The time zone to use for time correction. Pass NULL for GMT.
tz (CFTimeZoneRef) —

The time interval to add to at.
unitFlags (CFOptionFlags) —

The absolute time to convert.

Returns:

(CFGregorianUnits) —

The difference between the specified absolute times (as at1 - at2—if at1 is earlier than at2, the result is negative) expressed in the units specified by unitFlags.

- (`CFGregorianDate`) CFAbsoluteTimeGetGregorianDate(at, tz)

Converts an absolute time value into a Gregorian date.

Parameters:

at (CFAbsoluteTime) —

The absolute time to which the interval is added.
tz (CFTimeZoneRef) —

The time zone to use for time correction. Pass NULL for GMT.

Returns:

(CFGregorianDate) —

The Gregorian date equivalent for at.

- (`SInt32`) CFAbsoluteTimeGetWeekOfYear(at, tz)

Returns an integer representing the week of the year indicated by the specified absolute time.

Parameters:

at (CFAbsoluteTime) —

The absolute time to which the interval is added.
tz (CFTimeZoneRef) —

The time zone to use for time correction. Pass NULL for GMT.

Returns:

(SInt32) —

An integer (1-53) representing the week of the year specified by at. The numbering follows the ISO 8601 definition of week.

- (`Object`) CFAllocatorAllocate(allocator, size, hint)

Allocates memory using the specified allocator.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.
size (CFIndex) —

The size of the memory to allocate.
hint (CFOptionFlags) —

A bitfield containing flags that suggest how memory is to be allocated. 0 indicates no hints. No hints are currently defined, so only 0 should be passed for this value.

Returns:

(Object) —

A pointer to the newly allocated memory.

- (`CFAllocatorRef`) CFAllocatorCreate(allocator, context)

Creates an allocator object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFAllocatorContext) —

The size of the memory to allocate.

Returns:

(CFAllocatorRef) —

The new allocator object, or NULL if there was a problem allocating memory. Ownership follows the Create Rule.

- (`Object`) CFAllocatorDeallocate(allocator, ptr)

Deallocates a block of memory with a given allocator.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.
ptr (Object) —

The size of the memory to allocate.

Returns:

(Object) —

A reference to the default allocator for the current thread. If none has been explicitly set, returns the generic system allocator, kCFAllocatorSystemDefault. Ownership follows “The Get Rule” in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFAllocatorGetContext(allocator, context)

Obtains the context of the specified allocator or of the default allocator.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFAllocatorContext) —

The size of the memory to allocate.

Returns:

(Object) —

The number of bytes likely to be allocated upon a specific request.

- (`CFAllocatorRef`) CFAllocatorGetDefault

Gets the default allocator object for the current thread.

Returns:

(CFAllocatorRef) —

The type identifier for the CFAllocator opaque type.

- (`CFIndex`) CFAllocatorGetPreferredSizeForSize(allocator, size, hint)

Obtains the number of bytes likely to be allocated upon a specific request.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.
size (CFIndex) —

The size of the memory to allocate.
hint (CFOptionFlags) —

A bitfield containing flags that suggest how memory is to be allocated. 0 indicates no hints. No hints are currently defined, so only 0 should be passed for this value.

Returns:

(CFIndex)

- (`CFTypeID`) CFAllocatorGetTypeID

Returns the type identifier for the CFAllocator opaque type.

Returns:

(CFTypeID)

- (`nil`) CFAllocatorReallocate(allocator, ptr, newsize, hint)

Reallocates memory using the specified allocator.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.
ptr (Object) —

The size of the memory to allocate.
newsize (CFIndex) —

A bitfield containing flags that suggest how memory is to be allocated. 0 indicates no hints. No hints are currently defined, so only 0 should be passed for this value.
hint (CFOptionFlags) —

The existing allocator to use to allocate memory for the new allocator. Pass the kCFAllocatorUseContext constant for this parameter to allocate memory using the appropriate function callback specified in the context parameter. Pass NULL or kCFAllocatorDefault to allocate memory for the new allocator using the default allocator.

Returns:

(nil)

- (`nil`) CFAllocatorSetDefault(allocator)

Sets the given allocator as the default for the current thread.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate the memory. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(nil)

- (`Object`) CFArrayAppendArray(theArray, otherArray, otherRange)

Adds the values from one array to another array.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
otherArray (CFArrayRef) —

An array providing the values to be added to theArray.
otherRange (CFRange) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.

Returns:

(Object) —

A new mutable array, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`Object`) CFArrayAppendValue(theArray, value)

Adds a value to an array giving it the new largest index.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
value (Object) —

An array providing the values to be added to theArray.

Returns:

(Object) —

A new mutable array that contains the same values as theArray. The new array has the same count as the theArray and uses the same callbacks. Ownership follows the Create Rule.

- (`Object`) CFArrayApplyFunction(theArray, range, applier, context)

Calls a function once for each element in range in an array.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
applier (CFArrayApplierFunction) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.
context (Object) —

A pointer-sized program-defined value, which is passed as the second argument to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.

Returns:

(Object) —

The return value is one of the following:

- (`CFIndex`) CFArrayBSearchValues(theArray, range, value, comparator, context)

Searches an array for a value using a binary search algorithm.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
value (Object) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.
comparator (CFComparatorFunction) —

A pointer-sized program-defined value, which is passed as the second argument to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.
context (Object) —

An array, sorted from least to greatest according to the comparator function.

Returns:

(CFIndex) —

true, if value is in the specified range of theArray, otherwise false.

- (`Boolean`) CFArrayContainsValue(theArray, range, value)

Reports whether or not a value is in an array.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
value (Object) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(Boolean) —

A new immutable array containing numValues from values, or NULL if there was a problem creating the object. Ownership follows “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFArrayCreate(allocator, values, numValues, callBacks)

Creates a new immutable array with the given values.

Parameters:

allocator (CFAllocatorRef) —

The array to whose elements to apply the function.
values (Pointer) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
numValues (CFIndex) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.
callBacks (const CFArrayCallBacks) —

A pointer-sized program-defined value, which is passed as the second argument to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.

Returns:

(CFArrayRef) —

A new CFArray object that contains the same values as theArray. Ownership follows “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFArrayCreateCopy(allocator, theArray)

Creates a new immutable array with the values from another array.

Parameters:

allocator (CFAllocatorRef) —

The array to whose elements to apply the function.
theArray (CFArrayRef) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).

Returns:

(CFArrayRef) —

The number of values in theArray.

- (`CFMutableArrayRef`) CFArrayCreateMutable(allocator, capacity, callBacks)

Creates a new empty mutable array.

Parameters:

allocator (CFAllocatorRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
capacity (CFIndex) —

An array providing the values to be added to theArray.
callBacks (const CFArrayCallBacks) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.

Returns:

(CFMutableArrayRef)

- (`CFMutableArrayRef`) CFArrayCreateMutableCopy(allocator, capacity, theArray)

Creates a new mutable array with the values from another array.

Parameters:

allocator (CFAllocatorRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
capacity (CFIndex) —

An array providing the values to be added to theArray.
theArray (CFArrayRef) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.

Returns:

(CFMutableArrayRef)

- (`nil`) CFArrayExchangeValuesAtIndices(theArray, idx1, idx2)

Exchanges the values at two indices of an array.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
idx1 (CFIndex) —

An array providing the values to be added to theArray.
idx2 (CFIndex) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.

Returns:

(nil)

- (`CFIndex`) CFArrayGetCount(theArray)

Returns the number of values currently in an array.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.

Returns:

(CFIndex) —

The number of times value occurs in theArray, within the specified range.

- (`CFIndex`) CFArrayGetCountOfValue(theArray, range, value)

Counts the number of times a given value occurs in an array.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
value (Object) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFIndex) —

The lowest index of the matching values in the range, or -1 if no value in the range matched.

- (`CFIndex`) CFArrayGetFirstIndexOfValue(theArray, range, value)

Searches an array forward for a value.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
value (Object) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFIndex) —

The highest index of the matching values in the range, or -1 if no value in the range matched.

- (`CFIndex`) CFArrayGetLastIndexOfValue(theArray, range, value)

Searches an array backward for a value.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
value (Object) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFIndex) —

The type identifier for the CFArray opaque type.

- (`CFTypeID`) CFArrayGetTypeID

Returns the type identifier for the CFArray opaque type.

Returns:

(CFTypeID) —

The value at the idx index in theArray. If the return value is a Core Foundation Object, ownership follows “The Get Rule” in Memory Management Programming Guide for Core Foundation.

- (`const`) CFArrayGetValueAtIndex(theArray, idx)

Retrieves a value at a given index.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
idx (CFIndex) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).

Returns:

(const)

- (`nil`) CFArrayGetValues(theArray, range, values)

Fills a buffer with values from an array.

Parameters:

theArray (CFArrayRef) —

The array to whose elements to apply the function.
range (CFRange) —

The range of values within theArray to which to apply the applier function. The range must not exceed the bounds of theArray. The range may be empty (length 0).
values (Pointer) —

The callback function to call once for each value in the given range in theArray. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFArrayInsertValueAtIndex(theArray, idx, value)

Inserts a value into an array at a given index.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
idx (CFIndex) —

An array providing the values to be added to theArray.
value (Object) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.

Returns:

(nil)

- (`nil`) CFArrayRemoveAllValues(theArray)

Removes all the values from an array, making it empty.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.

Returns:

(nil)

- (`nil`) CFArrayRemoveValueAtIndex(theArray, idx)

Removes the value at a given index from an array.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
idx (CFIndex) —

An array providing the values to be added to theArray.

Returns:

(nil)

- (`nil`) CFArrayReplaceValues(theArray, range, newValues, newCount)

Replaces a range of values in an array.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
range (CFRange) —

An array providing the values to be added to theArray.
newValues (Pointer) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.
newCount (CFIndex) —

The array to which value is to be added. If theArray is a limited-capacity array and it is full before this operation, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFArraySetValueAtIndex(theArray, idx, value)

Changes the value at a given index in an array.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
idx (CFIndex) —

An array providing the values to be added to theArray.
value (Object) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.

Returns:

(nil)

- (`nil`) CFArraySortValues(theArray, range, comparator, context)

Sorts the values in an array using a given comparison function.

Parameters:

theArray (CFMutableArrayRef) —

The array to which values from otherArray are added. If theArray is a limited-capacity array, adding otherRange.length values from otherArray must not cause the capacity limit of theArray to be exceeded.
range (CFRange) —

An array providing the values to be added to theArray.
comparator (CFComparatorFunction) —

The range within otherArray from which to add the values to theArray. The range must not exceed the index space of otherArray.
context (Object) —

The array to which value is to be added. If theArray is a limited-capacity array and it is full before this operation, the behavior is undefined.

Returns:

(nil)

- (`Object`) CFAttributedStringBeginEditing(aStr)

Defers internal consistency-checking and coalescing for a mutable attributed string.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.

Returns:

(Object) —

A new mutable attributed string. Ownership follows the Create Rule.

- (`CFAttributedStringRef`) CFAttributedStringCreate(alloc, str, attributes)

Creates an attributed string with specified string and attributes.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
str (CFStringRef) —

A string that specifies the characters to use in the new attributed string. This value is copied.
attributes (CFDictionaryRef) —

A dictionary that contains the attributes to apply to the new attributed string. This value is copied.

Returns:

(CFAttributedStringRef) —

An attributed string that contains the characters from str and the attributes specified by attributes. The result is NULL if there was a problem in creating the attributed string. Ownership follows the Create Rule.

- (`CFAttributedStringRef`) CFAttributedStringCreateCopy(alloc, aStr)

Creates an immutable copy of an attributed string.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
aStr (CFAttributedStringRef) —

A string that specifies the characters to use in the new attributed string. This value is copied.

Returns:

(CFAttributedStringRef) —

An immutable attributed string with characters and attributes identical to those of aStr. Returns NULL if there was a problem copying the object. Ownership follows the Create Rule.

- (`CFMutableAttributedStringRef`) CFAttributedStringCreateMutable(alloc, maxLength)

Creates a mutable attributed string.

Parameters:

alloc (CFAllocatorRef) —

A mutable attributed string that is to be edited.
maxLength (CFIndex) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFMutableAttributedStringRef) —

A mutable copy of aStr. Ownership follows the Create Rule.

- (`CFMutableAttributedStringRef`) CFAttributedStringCreateMutableCopy(alloc, maxLength, aStr)

Creates a mutable copy of an attributed string.

Parameters:

alloc (CFAllocatorRef) —

A mutable attributed string that is to be edited.
maxLength (CFIndex) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
aStr (CFAttributedStringRef) —

The limit on the length of the new attributed string. The string starts empty and can grow to this length (it can be shorter).Pass 0 to specify that the maximum length is not limited. The value must not be negative.

Returns:

(CFMutableAttributedStringRef) —

The string for the specified attributed string as a mutable string.

- (`CFAttributedStringRef`) CFAttributedStringCreateWithSubstring(alloc, aStr, range)

Creates a sub-attributed string from the specified range.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
aStr (CFAttributedStringRef) —

A string that specifies the characters to use in the new attributed string. This value is copied.
range (CFRange) —

A dictionary that contains the attributes to apply to the new attributed string. This value is copied.

Returns:

(CFAttributedStringRef) —

A new attributed string whose string and attributes are copied from the specified range of the supplied attributed string. Returns NULL if there was a problem copying the object. Ownership follows the Create Rule.

- (`nil`) CFAttributedStringEndEditing(aStr)

Re-enables internal consistency-checking and coalescing for a mutable attributed string.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.

Returns:

(nil)

- (`CFTypeRef`) CFAttributedStringGetAttribute(aStr, loc, attrName, effectiveRange)

Returns the value of a given attribute of an attributed string at a specified location.

Parameters:

aStr (CFAttributedStringRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
loc (CFIndex) —

A string that specifies the characters to use in the new attributed string. This value is copied.
attrName (CFStringRef) —

A dictionary that contains the attributes to apply to the new attributed string. This value is copied.
effectiveRange (CFRange) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFTypeRef) —

The value of the specified attribute at the specified location in str. Ownership follows the Get Rule.

- (`CFTypeRef`) CFAttributedStringGetAttributeAndLongestEffectiveRange(aStr, loc, attrName, inRange, longestEffectiveRange)

Returns the value of a given attribute of an attributed string at a specified location.

Parameters:

aStr (CFAttributedStringRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
loc (CFIndex) —

A string that specifies the characters to use in the new attributed string. This value is copied.
attrName (CFStringRef) —

A dictionary that contains the attributes to apply to the new attributed string. This value is copied.
inRange (CFRange) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
longestEffectiveRange (CFRange) —

The attributed string to copy.

Returns:

(CFTypeRef) —

A dictionary that contains the attributes of str at the specified location. Ownership follows the Get Rule.

- (`CFDictionaryRef`) CFAttributedStringGetAttributes(aStr, loc, effectiveRange)

Returns the attributes of an attributed string at a specified location.

Parameters:

aStr (CFAttributedStringRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
loc (CFIndex) —

A string that specifies the characters to use in the new attributed string. This value is copied.
effectiveRange (CFRange) —

A dictionary that contains the attributes to apply to the new attributed string. This value is copied.

Returns:

(CFDictionaryRef) —

A dictionary that contains the attributes of str at the specified location. Ownership follows the Get Rule.

- (`CFDictionaryRef`) CFAttributedStringGetAttributesAndLongestEffectiveRange(aStr, loc, inRange, longestEffectiveRange)

Returns the attributes of an attributed string at a specified location.

Parameters:

aStr (CFAttributedStringRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
loc (CFIndex) —

A string that specifies the characters to use in the new attributed string. This value is copied.
inRange (CFRange) —

A dictionary that contains the attributes to apply to the new attributed string. This value is copied.
longestEffectiveRange (CFRange) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFDictionaryRef) —

A dictionary that contains the attributes of str at the specified location. Ownership follows the Get Rule.

- (`CFIndex`) CFAttributedStringGetLength(aStr)

Returns the length of the attributed string in characters.

Parameters:

aStr (CFAttributedStringRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFIndex) —

The length of the attributed string in characters; this is the same as CFStringGetLength(CFAttributedStringGetString(aStr)).

- (`CFMutableStringRef`) CFAttributedStringGetMutableString(aStr)

Gets as a mutable string the string for an attributed string.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.

Returns:

(CFMutableStringRef)

- (`CFStringRef`) CFAttributedStringGetString(aStr)

Returns the string for an attributed string.

Parameters:

aStr (CFAttributedStringRef) —

The allocator to use to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFStringRef) —

An immutable string containing the characters from aStr, or NULL if there was a problem creating the object. Ownership follows the Get Rule.

- (`CFTypeID`) CFAttributedStringGetTypeID

Returns the type identifier for the CFAttributedString opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFAttributedString opaque type.

- (`nil`) CFAttributedStringRemoveAttribute(aStr, range, attrName)

Removes the value of a single attribute over a specified range.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.
range (CFRange) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
attrName (CFStringRef) —

The limit on the length of the new attributed string. The string starts empty and can grow to this length (it can be shorter).Pass 0 to specify that the maximum length is not limited. The value must not be negative.

Returns:

(nil)

- (`nil`) CFAttributedStringReplaceAttributedString(aStr, range, replacement)

Replaces the attributed substring over a range with another attributed string.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.
range (CFRange) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
replacement (CFAttributedStringRef) —

The limit on the length of the new attributed string. The string starts empty and can grow to this length (it can be shorter).Pass 0 to specify that the maximum length is not limited. The value must not be negative.

Returns:

(nil)

- (`nil`) CFAttributedStringReplaceString(aStr, range, replacement)

Modifies the string of an attributed string.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.
range (CFRange) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
replacement (CFStringRef) —

The limit on the length of the new attributed string. The string starts empty and can grow to this length (it can be shorter).Pass 0 to specify that the maximum length is not limited. The value must not be negative.

Returns:

(nil)

- (`nil`) CFAttributedStringSetAttribute(aStr, range, attrName, value)

Sets the value of a single attribute over the specified range.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.
range (CFRange) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
attrName (CFStringRef) —

The limit on the length of the new attributed string. The string starts empty and can grow to this length (it can be shorter).Pass 0 to specify that the maximum length is not limited. The value must not be negative.
value (CFTypeRef) —

The allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(nil)

- (`nil`) CFAttributedStringSetAttributes(aStr, range, replacement, clearOtherAttributes)

Sets the value of attributes of a mutable attributed string over a specified range.

Parameters:

aStr (CFMutableAttributedStringRef) —

A mutable attributed string that is to be edited.
range (CFRange) —

An allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
replacement (CFDictionaryRef) —

The limit on the length of the new attributed string. The string starts empty and can grow to this length (it can be shorter).Pass 0 to specify that the maximum length is not limited. The value must not be negative.
clearOtherAttributes (Boolean) —

The allocator to be used to allocate memory for the new attributed string. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(nil)

- (`Object`) CFBagAddValue(theBag, value)

Adds a value to a mutable bag.

Parameters:

theBag (CFMutableBagRef) —

The bag to which value is added.
value (Object) —

A CFType object or a pointer value to add to theBag (or the value itself, if it fits into the size of a pointer).

Returns:

(Object) —

A new mutable bag, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`Object`) CFBagApplyFunction(theBag, applier, context)

Calls a function once for each value in a bag.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.
applier (CFBagApplierFunction) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.
context (Object) —

A pointer-sized program-defined value, which is passed as the second parameter to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.

Returns:

(Object) —

true if value is contained in theBag, otherwise false.

- (`Boolean`) CFBagContainsValue(theBag, value)

Reports whether or not a value is in a bag.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.
value (Object) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(Boolean) —

A new bag, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFBagRef`) CFBagCreate(allocator, values, numValues, callBacks)

Creates an immutable bag containing specified values.

Parameters:

allocator (CFAllocatorRef) —

The bag to operate upon.
values (Pointer) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.
numValues (CFIndex) —

A pointer-sized program-defined value, which is passed as the second parameter to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.
callBacks (const CFBagCallBacks) —

The bag to examine.

Returns:

(CFBagRef) —

A new bag that contains the same values as theBag, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFBagRef`) CFBagCreateCopy(allocator, theBag)

Creates an immutable bag with the values of another bag.

Parameters:

allocator (CFAllocatorRef) —

The bag to operate upon.
theBag (CFBagRef) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFBagRef) —

The number of values in theBag.

- (`CFMutableBagRef`) CFBagCreateMutable(allocator, capacity, callBacks)

Creates a new empty mutable bag.

Parameters:

allocator (CFAllocatorRef) —

The bag to which value is added.
capacity (CFIndex) —

A CFType object or a pointer value to add to theBag (or the value itself, if it fits into the size of a pointer).
callBacks (const CFBagCallBacks) —

The allocator object to use to allocate memory for the new bag and its storage for values. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFMutableBagRef) —

A new mutable bag that contains the same values as theBag. Ownership follows the Create Rule.

- (`CFMutableBagRef`) CFBagCreateMutableCopy(allocator, capacity, theBag)

Creates a new mutable bag with the values from another bag.

Parameters:

allocator (CFAllocatorRef) —

The bag to which value is added.
capacity (CFIndex) —

A CFType object or a pointer value to add to theBag (or the value itself, if it fits into the size of a pointer).
theBag (CFBagRef) —

The allocator object to use to allocate memory for the new bag and its storage for values. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFMutableBagRef)

- (`CFIndex`) CFBagGetCount(theBag)

Returns the number of values currently in a bag.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.

Returns:

(CFIndex) —

The number of times value occurs in theBag.

- (`CFIndex`) CFBagGetCountOfValue(theBag, value)

Returns the number of times a value occurs in a bag.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.
value (Object) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFIndex) —

The type identifier for the CFBag opaque type.

- (`CFTypeID`) CFBagGetTypeID

Returns the type identifier for the CFBag opaque type.

Returns:

(CFTypeID) —

A pointer to value, or NULL if value is not in theBag. If the value is a Core Foundation object, ownership follows the Get Rule.

- (`const`) CFBagGetValue(theBag, value)

Returns a requested value from a bag.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.
value (Object) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(const) —

true if value is present in theBag, otherwise false.

- (`Boolean`) CFBagGetValueIfPresent(theBag, candidate, value)

Reports whether or not a value is in a bag, and returns that value indirectly if it exists.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.
candidate (Object) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.
value (Pointer) —

A pointer-sized program-defined value, which is passed as the second parameter to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.

Returns:

(Boolean)

- (`nil`) CFBagGetValues(theBag, values)

Fills a buffer with values from a bag.

Parameters:

theBag (CFBagRef) —

The bag to operate upon.
values (Pointer) —

The callback function to call once for each value in the theBag. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the range that the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFBagRemoveAllValues(theBag)

Removes all values from a mutable bag.

Parameters:

theBag (CFMutableBagRef) —

The bag to which value is added.

Returns:

(nil)

- (`nil`) CFBagRemoveValue(theBag, value)

Removes a value from a mutable bag.

Parameters:

theBag (CFMutableBagRef) —

The bag to which value is added.
value (Object) —

A CFType object or a pointer value to add to theBag (or the value itself, if it fits into the size of a pointer).

Returns:

(nil)

- (`nil`) CFBagReplaceValue(theBag, value)

Replaces a value in a mutable bag.

Parameters:

theBag (CFMutableBagRef) —

The bag to which value is added.
value (Object) —

A CFType object or a pointer value to add to theBag (or the value itself, if it fits into the size of a pointer).

Returns:

(nil)

- (`nil`) CFBagSetValue(theBag, value)

Sets a value in a mutable bag.

Parameters:

theBag (CFMutableBagRef) —

The bag to which value is added.
value (Object) —

A CFType object or a pointer value to add to theBag (or the value itself, if it fits into the size of a pointer).

Returns:

(nil)

- (`Object`) CFBinaryHeapAddValue(heap, value)

Adds a value to a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.
value (Object) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.

Returns:

(Object) —

true if value is a member of heap, false otherwise.

- (`Object`) CFBinaryHeapApplyFunction(heap, applier, context)

Iteratively applies a function to all the values in a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.
applier (CFBinaryHeapApplierFunction) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.
context (Object) —

The binary heap to use.

Returns:

(Object) —

A new CFBinaryHeap object. Ownership follows the Create Rule.

- (`Boolean`) CFBinaryHeapContainsValue(heap, value)

Returns whether a given value is in a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.
value (Object) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.

Returns:

(Boolean) —

A new CFBinaryHeap object holding the same values as heap. The new binary heap uses the same callbacks as heap. Ownership follows the Create Rule.

- (`CFBinaryHeapRef`) CFBinaryHeapCreate(allocator, capacity, callBacks, compareContext)

Creates a new mutable or fixed-mutable binary heap.

Parameters:

allocator (CFAllocatorRef) —

The binary heap to use.
capacity (CFIndex) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.
callBacks (const CFBinaryHeapCallBacks) —

The binary heap to use.
compareContext (const CFBinaryHeapCompareContext) —

The callback function to call once for each value in heap.

Returns:

(CFBinaryHeapRef) —

The number of values in heap.

- (`CFBinaryHeapRef`) CFBinaryHeapCreateCopy(allocator, capacity, heap)

Creates a new mutable or fixed-mutable binary heap with the values from a pre-existing binary heap.

Parameters:

allocator (CFAllocatorRef) —

The binary heap to use.
capacity (CFIndex) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.
heap (CFBinaryHeapRef) —

The binary heap to use.

Returns:

(CFBinaryHeapRef) —

The number of times value occurs in heap.

- (`CFIndex`) CFBinaryHeapGetCount(heap)

Returns the number of values currently in a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.

Returns:

(CFIndex) —

The minimum value in heap as determined by the binary heap’s compare callback. If heap contains several equal minimum values, any one may be returned. If the value is a Core Foundation object, ownership follows the Get Rule.

- (`CFIndex`) CFBinaryHeapGetCountOfValue(heap, value)

Counts the number of times a given value occurs in a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.
value (Object) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.

Returns:

(CFIndex) —

true if a minimum value exists in heap, false otherwise. false is returned only if heap is empty.

- (`const`) CFBinaryHeapGetMinimum(heap)

Returns the minimum value in a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.

Returns:

(const) —

The type identifier of the CFBinaryHeap opaque type.

- (`Boolean`) CFBinaryHeapGetMinimumIfPresent(heap, value)

Returns the minimum value in a binary heap, if present.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.
value (Pointer) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.

Returns:

(Boolean)

- (`CFTypeID`) CFBinaryHeapGetTypeID

Returns the type identifier of the CFBinaryHeap opaque type.

Returns:

(CFTypeID)

- (`nil`) CFBinaryHeapGetValues(heap, values)

Copies all the values from a binary heap into a sorted C array.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.
values (Pointer) —

The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided in the CFBinaryHeapCallBacks structure when the binary heap was created.

Returns:

(nil)

- (`nil`) CFBinaryHeapRemoveAllValues(heap)

Removes all values from a binary heap, making it empty.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.

Returns:

(nil)

- (`nil`) CFBinaryHeapRemoveMinimumValue(heap)

Removes the minimum value from a binary heap.

Parameters:

heap (CFBinaryHeapRef) —

The binary heap to use.

Returns:

(nil)

- (`Boolean`) CFBitVectorContainsBit(bv, range, value)

Returns whether a bit vector contains a particular bit value.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.
range (CFRange) —

The range of bits in bv to search.
value (CFBit) —

The bit value for which to search.

Returns:

(Boolean) —

true if the specified range of bits in bv contains value, otherwise false.

- (`CFBitVectorRef`) CFBitVectorCreate(allocator, bytes, numBits)

Creates an immutable bit vector from a block of memory.

Parameters:

allocator (CFAllocatorRef) —

The bit vector to search.
bytes (const UInt8) —

The range of bits in bv to search.
numBits (CFIndex) —

The bit value for which to search.

Returns:

(CFBitVectorRef) —

A new bit vector. Ownership follows the Create Rule.

- (`CFBitVectorRef`) CFBitVectorCreateCopy(allocator, bv)

Creates an immutable bit vector that is a copy of another bit vector.

Parameters:

allocator (CFAllocatorRef) —

The bit vector to search.
bv (CFBitVectorRef) —

The range of bits in bv to search.

Returns:

(CFBitVectorRef) —

A new bit vector holding the same bit values as bv. Ownership follows the Create Rule.

- (`CFMutableBitVectorRef`) CFBitVectorCreateMutable(allocator, capacity)

Creates a mutable bit vector.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
capacity (CFIndex) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.

Returns:

(CFMutableBitVectorRef) —

A new bit vector. Ownership follows the Create Rule.

- (`CFMutableBitVectorRef`) CFBitVectorCreateMutableCopy(allocator, capacity, bv)

Creates a new mutable bit vector from a pre-existing bit vector.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
capacity (CFIndex) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.
bv (CFBitVectorRef) —

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

Returns:

(CFMutableBitVectorRef) —

A new bit vector holding the same bit values as bv. Ownership follows the Create Rule

- (`nil`) CFBitVectorFlipBitAtIndex(bv, idx)

Flips a bit value in a bit vector.

Parameters:

bv (CFMutableBitVectorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
idx (CFIndex) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.

Returns:

(nil)

- (`nil`) CFBitVectorFlipBits(bv, range)

Flips a range of bit values in a bit vector.

Parameters:

bv (CFMutableBitVectorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
range (CFRange) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.

Returns:

(nil)

- (`CFBit`) CFBitVectorGetBitAtIndex(bv, idx)

Returns the bit value at a given index in a bit vector.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.
idx (CFIndex) —

The range of bits in bv to search.

Returns:

(CFBit) —

The bit value at index idx in bv.

- (`Object`) CFBitVectorGetBits(bv, range, bytes)

Returns the bit values in a range of indices in a bit vector.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.
range (CFRange) —

The range of bits in bv to search.
bytes (UInt8) —

The bit value for which to search.

Returns:

(Object) —

The current size of bv.

- (`CFIndex`) CFBitVectorGetCount(bv)

Returns the number of bit values in a bit vector.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.

Returns:

(CFIndex) —

The number of occurrences of value in the specified range of bv.

- (`CFIndex`) CFBitVectorGetCountOfBit(bv, range, value)

Counts the number of times a certain bit value occurs within a range of bits in a bit vector.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.
range (CFRange) —

The range of bits in bv to search.
value (CFBit) —

The bit value for which to search.

Returns:

(CFIndex) —

The index of the first occurrence of value in the specified range of bv, or kCFNotFound if value is not present.

- (`CFIndex`) CFBitVectorGetFirstIndexOfBit(bv, range, value)

Locates the first occurrence of a certain bit value within a range of bits in a bit vector.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.
range (CFRange) —

The range of bits in bv to search.
value (CFBit) —

The bit value for which to search.

Returns:

(CFIndex) —

The index of the last occurrence of value in the specified range of bv, or kCFNotFound if value is not present.

- (`CFIndex`) CFBitVectorGetLastIndexOfBit(bv, range, value)

Locates the last occurrence of a certain bit value within a range of bits in a bit vector.

Parameters:

bv (CFBitVectorRef) —

The bit vector to search.
range (CFRange) —

The range of bits in bv to search.
value (CFBit) —

The bit value for which to search.

Returns:

(CFIndex) —

The type identifier for the CFBitVector opaque type.

- (`CFTypeID`) CFBitVectorGetTypeID

Returns the type identifier for the CFBitVector opaque type.

Returns:

(CFTypeID)

- (`nil`) CFBitVectorSetAllBits(bv, value)

Sets all bits in a bit vector to a particular value.

Parameters:

bv (CFMutableBitVectorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
value (CFBit) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.

Returns:

(nil)

- (`nil`) CFBitVectorSetBitAtIndex(bv, idx, value)

Sets the value of a particular bit in a bit vector.

Parameters:

bv (CFMutableBitVectorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
idx (CFIndex) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.
value (CFBit) —

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

Returns:

(nil)

- (`nil`) CFBitVectorSetBits(bv, range, value)

Sets a range of bits in a bit vector to a particular value.

Parameters:

bv (CFMutableBitVectorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
range (CFRange) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.
value (CFBit) —

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

Returns:

(nil)

- (`nil`) CFBitVectorSetCount(bv, count)

Changes the size of a mutable bit vector.

Parameters:

bv (CFMutableBitVectorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
count (CFIndex) —

The maximum number of values that can be contained by the new bit vector. The bit vector starts empty and can grow to this number of values (and it can have less).Pass 0 to specify that the maximum capacity is not limited. The value must not be negative.

Returns:

(nil)

- (`CFTypeID`) CFBooleanGetTypeID

Returns the Core Foundation type identifier for the CFBoolean opaque type.

Returns:

(CFTypeID) —

The Core Foundation type identifier for CFBoolean opaque type.

- (`Boolean`) CFBooleanGetValue(boolean)

Returns the value of a CFBoolean object as a standard C type Boolean.

Parameters:

boolean (CFBooleanRef) —

The boolean to examine.

Returns:

(Boolean) —

The value of boolean.

- (`Object`) CFBundleCloseBundleResourceMap(bundle, refNum)

Closes an open resource map for a bundle.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
refNum (CFBundleRefNum) —

The reference number for a resource map to close.

Returns:

(Object) —

The URL location of the specified bundle’s auxiliary executable code, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyAuxiliaryExecutableURL(bundle, executableName)

Returns the location of a bundle’s auxiliary executable code.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
executableName (CFStringRef) —

The reference number for a resource map to close.

Returns:

(CFURLRef) —

A CFURL object describing the location of bundle’s built in plug-ins, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyBuiltInPlugInsURL(bundle)

Returns the location of a bundle’s built in plug-in.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

An array containing bundle’s localizations. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyBundleLocalizations(bundle)

Returns an array containing a bundle’s localizations.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFArrayRef) —

A CFURL object describing the location of bundle, or NULL if the specified bundle does not exist. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyBundleURL(bundle)

Returns the location of a bundle.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

If the bundle’s executable exists and is a Mach-O file, returns an array of CFNumbers whose values are integers representing the architectures the file provides. Possible values are listed in “Architecture Types.” If the executable is not a Mach-O file, returns NULL. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyExecutableArchitectures(bundle)

Returns an array of CFNumbers representing the architectures a given bundle provides.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFArrayRef) —

For a directory URL, if the bundle’s executable exists and is a Mach-O file, returns an array of CFNumbers whose values are integers representing the architectures the URL provides. For a plain file URL representing an unbundled executable, returns the architectures it provides if it is a Mach-O file. Possible values are listed in “Architecture Types.” If there is no bundle executable or if the executable is not a Mach-O file, returns NULL. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyExecutableArchitecturesForURL(url)

Returns an array of CFNumbers representing the architectures a given URL provides.

Parameters:

url (CFURLRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFArrayRef) —

A CFURL object describing the location of bundle’s executable code, or NULL if none is found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyExecutableURL(bundle)

Returns the location of a bundle’s main executable code.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

A CFDictionary object containing url’s information dictionary. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFDictionaryRef`) CFBundleCopyInfoDictionaryForURL(url)

Returns the information dictionary for a given URL location.

Parameters:

url (CFURLRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFDictionaryRef) —

A CFDictionary object containing the information dictionary for a bundle located at bundleURL. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFDictionaryRef`) CFBundleCopyInfoDictionaryInDirectory(bundleURL)

Returns a bundle’s information dictionary.

Parameters:

bundleURL (CFURLRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFDictionaryRef) —

An array containing the localizations that CFBundle would use. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyLocalizationsForPreferences(locArray, prefArray)

Given an array of possible localizations and preferred locations, returns the one or more of them that CFBundle would use, without reference to the current application context.

Parameters:

locArray (CFArrayRef) —

The bundle whose resource map is referenced by refNum.
prefArray (CFArrayRef) —

The reference number for a resource map to close.

Returns:

(CFArrayRef) —

An array containing the localizations available at url. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyLocalizationsForURL(url)

Returns an array containing the localizations for a bundle or executable at a particular location.

Parameters:

url (CFURLRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFArrayRef) —

A CFString object that contains the localized string. If no value exists for key, returns value unless value is NULL or an empty string, in which case key is returned instead. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFBundleCopyLocalizedString(bundle, key, value, tableName)

Returns a localized string from a bundle’s strings file.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
key (CFStringRef) —

The reference number for a resource map to close.
value (CFStringRef) —

The bundle to examine.
tableName (CFStringRef) —

The name of bundle’s auxiliary executable code.

Returns:

(CFStringRef) —

A subset of locArray that CFBundle would use in the current application context. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyPreferredLocalizationsFromArray(locArray)

Given an array of possible localizations, returns the one or more of them that CFBundle would use in the current application context.

Parameters:

locArray (CFArrayRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFArrayRef) —

A CFURL object describing the location of bundle’s private frameworks directory, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyPrivateFrameworksURL(bundle)

Returns the location of a bundle’s private Frameworks directory.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

A CFURL object describing the location of bundle’s resources directory, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyResourcesDirectoryURL(bundle)

Returns the location of a bundle’s Resources directory.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

A CFURL object describing the location of the requested resource, or NULL if the resource cannot be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyResourceURL(bundle, resourceName, resourceType, subDirName)

Returns the location of a resource contained in the specified bundle.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
resourceName (CFStringRef) —

The reference number for a resource map to close.
resourceType (CFStringRef) —

The bundle to examine.
subDirName (CFStringRef) —

The name of bundle’s auxiliary executable code.

Returns:

(CFURLRef) —

The location of a localized resource in bundle, or NULL if the resource could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyResourceURLForLocalization(bundle, resourceName, resourceType, subDirName, localizationName)

Returns the location of a localized resource in a bundle.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
resourceName (CFStringRef) —

The reference number for a resource map to close.
resourceType (CFStringRef) —

The bundle to examine.
subDirName (CFStringRef) —

The name of bundle’s auxiliary executable code.
localizationName (CFStringRef) —

The bundle to examine.

Returns:

(CFURLRef) —

A CFURL object describing the location of the requested resource, or NULL if the resource cannot be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopyResourceURLInDirectory(bundleURL, resourceName, resourceType, subDirName)

Returns the location of a resource contained in the specified bundle directory without requiring the creation of a CFBundle object.

Parameters:

bundleURL (CFURLRef) —

The bundle whose resource map is referenced by refNum.
resourceName (CFStringRef) —

The reference number for a resource map to close.
resourceType (CFStringRef) —

The bundle to examine.
subDirName (CFStringRef) —

The name of bundle’s auxiliary executable code.

Returns:

(CFURLRef) —

A CFArray object containing CFURL objects of the requested resources. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyResourceURLsOfType(bundle, resourceType, subDirName)

Assembles an array of URLs specifying all of the resources of the specified type found in a bundle.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
resourceType (CFStringRef) —

The reference number for a resource map to close.
subDirName (CFStringRef) —

The bundle to examine.

Returns:

(CFArrayRef) —

A CFArray object containing copies of the requested locations. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyResourceURLsOfTypeForLocalization(bundle, resourceType, subDirName, localizationName)

Returns an array containing copies of the URL locations for a specified bundle, resource, and localization name.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
resourceType (CFStringRef) —

The reference number for a resource map to close.
subDirName (CFStringRef) —

The bundle to examine.
localizationName (CFStringRef) —

The name of bundle’s auxiliary executable code.

Returns:

(CFArrayRef) —

A CFArray object containing the CFURL objects of the requested resources. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleCopyResourceURLsOfTypeInDirectory(bundleURL, resourceType, subDirName)

Returns an array of CFURL objects describing the locations of all resources in a bundle of the specified type without needing to create a CFBundle object.

Parameters:

bundleURL (CFURLRef) —

The bundle whose resource map is referenced by refNum.
resourceType (CFStringRef) —

The reference number for a resource map to close.
subDirName (CFStringRef) —

The bundle to examine.

Returns:

(CFArrayRef) —

A CFURL object containing the location of bundle’s shared frameworks directory, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopySharedFrameworksURL(bundle)

Returns the location of a bundle’s shared frameworks directory.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

A CFURL object containing the location of bundle’s shared support files directory, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopySharedSupportURL(bundle)

Returns the location of a bundle’s shared support files directory.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

A CFURL object describing the location of the bundle’s support files directory, or NULL if it could not be found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFBundleCopySupportFilesDirectoryURL(bundle)

Returns the location of the bundle’s support files directory.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFURLRef) —

A CFBundle object created from the bundle at bundleURL. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFBundleRef`) CFBundleCreate(allocator, bundleURL)

Creates a CFBundle object.

Parameters:

allocator (CFAllocatorRef) —

The bundle whose resource map is referenced by refNum.
bundleURL (CFURLRef) —

The reference number for a resource map to close.

Returns:

(CFBundleRef) —

Returns NULL if there was a memory allocation problem. May return an existing CFBundle object with the reference count incremented. May return NULL if the bundle doesn’t exist at bundleURL (see Discussion).

- (`CFArrayRef`) CFBundleCreateBundlesFromDirectory(allocator, directoryURL, bundleType)

Searches a directory and constructs an array of CFBundle objects from all valid bundles in the specified directory.

Parameters:

allocator (CFAllocatorRef) —

The bundle whose resource map is referenced by refNum.
directoryURL (CFURLRef) —

The reference number for a resource map to close.
bundleType (CFStringRef) —

The bundle to examine.

Returns:

(CFArrayRef) —

A CFArray object containing CFBundle objects created from the contents of the specified directory. Returns an empty array if no bundles exist at directoryURL, and NULL if there was a memory allocation problem. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFBundleGetAllBundles

Returns an array containing all of the bundles currently open in the application.

Returns:

(CFArrayRef) —

A CFArray object containing CFBundle objects for each open bundle in the application. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFBundleRef`) CFBundleGetBundleWithIdentifier(bundleID)

Locate a bundle given its program-defined identifier.

Parameters:

bundleID (CFStringRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFBundleRef) —

A CFBundle object, or NULL if the bundle was not found. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFBundleGetDataPointerForName(bundle, symbolName)

Returns a data pointer to a symbol of the given name.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
symbolName (CFStringRef) —

The reference number for a resource map to close.

Returns:

(Object) —

A data pointer to a symbol named symbolName in bundle, or NULL if symbolName cannot be found. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFBundleGetDataPointersForNames(bundle, symbolNames, stbl[])

Returns a C array of data pointer to symbols of the given names.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
symbolNames (CFArrayRef) —

The reference number for a resource map to close.
stbl[] (Object) —

The bundle to examine.

Returns:

(Object) —

A CFString object containing the name of the bundle’s development region. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFBundleGetDevelopmentRegion(bundle)

Returns the bundle’s development region from the bundle’s information property list.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFStringRef) —

A pointer to a function in a bundle’s executable code, or NULL if functionName cannot be found. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFBundleGetFunctionPointerForName(bundle, functionName)

Returns a pointer to a function in a bundle’s executable code using the function name as the search key.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
functionName (CFStringRef) —

The reference number for a resource map to close.

Returns:

(Object) —

A CFString object containing the bundle’s identifier, or NULL if none was specified in the information property list. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFBundleGetFunctionPointersForNames(bundle, functionNames, ftbl[])

Constructs a function table containing pointers to all of the functions found in a bundle’s main executable code.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
functionNames (CFArrayRef) —

The reference number for a resource map to close.
ftbl[] (Object) —

The bundle to examine.

Returns:

(Object) —

A CFDictionary object containing the data stored in the bundle’s information property list (the Info.plist file). This is a global information dictionary. CFBundle may add extra keys to this dictionary for its own use. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFBundleGetIdentifier(bundle)

Returns the bundle identifier from a bundle’s information property list.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFStringRef) —

A dictionary containing the key-value pairs in bundle’s localized information dictionary (from the InfoPlist.strings file for the current locale). Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFDictionaryRef`) CFBundleGetInfoDictionary(bundle)

Returns a bundle’s information dictionary.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFDictionaryRef) —

A CFBundle object representing the application’s main bundle, or NULL if it is not possible to create a bundle. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFDictionaryRef`) CFBundleGetLocalInfoDictionary(bundle)

Returns a bundle’s localized information dictionary.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFDictionaryRef) —

true if the package type and creator were found, otherwise false.

- (`CFBundleRef`) CFBundleGetMainBundle

Returns an application’s main bundle.

Returns:

(CFBundleRef) —

The plug-in for bundle. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFBundleGetPackageInfo(bundle, packageType, packageCreator)

Returns a bundle’s package type and creator.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
packageType (UInt32) —

The reference number for a resource map to close.
packageCreator (UInt32) —

The bundle to examine.

Returns:

(Object) —

The type identifier for the CFBundle opaque type.

- (`Boolean`) CFBundleGetPackageInfoInDirectory(url, packageType, packageCreator)

Returns a bundle’s package type and creator without having to create a CFBundle object.

Parameters:

url (CFURLRef) —

The bundle whose resource map is referenced by refNum.
packageType (UInt32) —

The reference number for a resource map to close.
packageCreator (UInt32) —

The bundle to examine.

Returns:

(Boolean) —

A value corresponding to key in bundle’s information dictionary. If available, a localized value is returned, otherwise the global value is returned. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFPlugInRef`) CFBundleGetPlugIn(bundle)

Returns a bundle’s plug-in.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFPlugInRef) —

A vers resource style version number. If it is a string, it is automatically converted to the numeric representation, where the major version number is restricted to 2 BCD digits (in other words, it must be in the range 0-99) and the minor and bug fix version numbers are each restricted to a single BCD digit (0-9).

- (`CFTypeID`) CFBundleGetTypeID

Returns the type identifier for the CFBundle opaque type.

Returns:

(CFTypeID) —

true if bundle’s main executable has been loaded, otherwise false.

- (`CFTypeRef`) CFBundleGetValueForInfoDictionaryKey(bundle, key)

Returns a value (localized if possible) from a bundle’s information dictionary.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
key (CFStringRef) —

The reference number for a resource map to close.

Returns:

(CFTypeRef) —

true if the executable was successfully loaded, otherwise false.

- (`UInt32`) CFBundleGetVersionNumber(bundle)

Returns a bundle’s version number.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(UInt32) —

If bundle is already loaded, returns true. If bundle is not already loaded, attempts to load bundle; if that attempt succeeds returns true, otherwise returns false.

- (`Boolean`) CFBundleIsExecutableLoaded(bundle)

Obtains information about the load status for a bundle’s main executable.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(Boolean) —

An error code. The function returns 0 (noErr) if successful. If the bundle contains more than one resource file, the function returns an error code only if none was opened. The most common error is resFNotFound, but the function may also pass through other errors returned from the Resource Manager.

- (`Boolean`) CFBundleLoadExecutable(bundle)

Loads a bundle’s main executable code into memory and dynamically links it into the running application.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(Boolean) —

A distinct reference number for the resource map.

- (`Boolean`) CFBundleLoadExecutableAndReturnError(bundle, error)

Returns a Boolean value that indicates whether a given bundle is loaded, attempting to load it if necessary.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
error (CFErrorRef) —

The reference number for a resource map to close.

Returns:

(Boolean) —

true if bundle is loaded or upon inspection appears to be loadable, otherwise false.

- (`SInt32`) CFBundleOpenBundleResourceFiles(bundle, refNum, localizedRefNum)

Opens the non-localized and localized resource files (if any) for a bundle in separate resource maps.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
refNum (CFBundleRefNum) —

The reference number for a resource map to close.
localizedRefNum (CFBundleRefNum) —

The bundle to examine.

Returns:

(SInt32) —

The localized version of the requested string. Returns key if no value corresponding to key is found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFBundleRefNum`) CFBundleOpenBundleResourceMap(bundle)

Opens the non-localized and localized resource files (if any) for a bundle in a single resource map.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(CFBundleRefNum) —

The localized version of the requested string, or key if no value corresponding to key is found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`Boolean`) CFBundlePreflightExecutable(bundle, error)

Returns a Boolean value that indicates whether a given bundle is loaded or appears to be loadable.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.
error (CFErrorRef) —

The reference number for a resource map to close.

Returns:

(Boolean) —

The localized version of the requested string, or key if no value corresponding to key is found. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFBundleUnloadExecutable(bundle)

Unloads the main executable for the specified bundle.

Parameters:

bundle (CFBundleRef) —

The bundle whose resource map is referenced by refNum.

Returns:

(Object) —

The localized version of the requested string. If no value corresponding to key is found, returns value, unless value is NULL or an empty string, in which case key is returned instead. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFByteOrder`) CFByteOrderGetCurrent

Returns the byte order of the current computer.

Returns:

(CFByteOrder) —

The byte order of the current computer. See “Byte Order Flags” for the list of possible return values.

- (`Boolean`) CFCalendarAddComponents(calendar, at, options, componentDesc)

Computes the absolute time when specified components are added to a given absolute time.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
at (CFAbsoluteTime) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
options (CFOptionFlags) —

Options for the calculation. For valid values, see “Constants.”
componentDesc (const unsigned char) —

A string that describes the components provided in the vararg parameters.

Returns:

(Boolean) —

TRUE—and in at the computed time—if at falls inside the defined range of the calendar and it is possible to calculate the absolute time when the components (the calendrical components specified by componentDesc and given in the varargs) are added to the input absolute time at; otherwise FALSE.

- (`Boolean`) CFCalendarComposeAbsoluteTime(calendar, at, componentDesc)

Computes the absolute time from components in a description string.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
at (CFAbsoluteTime) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
componentDesc (const unsigned char) —

Options for the calculation. For valid values, see “Constants.”

Returns:

(Boolean) —

TRUE—and in at the absolute time computed from the given components—if the componentDesc description string can be converted into an absolute time, otherwise FALSE. Also returns FALSE for out-of-range values.

- (`CFCalendarRef`) CFCalendarCopyCurrent

Returns a copy of the logical calendar for the current user.

Returns:

(CFCalendarRef) —

The logical calendar for the current user that is formed from the settings for the current user’s chosen system locale overlaid with any custom settings the user has specified in System Preferences. This function may return a retained cached object, not a new object. Ownership follows the Create Rule.

- (`CFLocaleRef`) CFCalendarCopyLocale(calendar)

Returns a locale object for a specified calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.

Returns:

(CFLocaleRef) —

A copy of the locale object for the specified calendar. Ownership follows the Create Rule.

- (`CFTimeZoneRef`) CFCalendarCopyTimeZone(calendar)

Returns a time zone object for a specified calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.

Returns:

(CFTimeZoneRef) —

A copy of the time zone object for the specified calendar. Ownership follows the Create Rule.

- (`CFCalendarRef`) CFCalendarCreateWithIdentifier(allocator, identifier)

Returns a calendar object for the calendar identified by a calendar identifier.

Parameters:

allocator (CFAllocatorRef) —

The calendar to use for the computation.
identifier (CFStringRef) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(CFCalendarRef) —

A calendar object for the calendar identified by ident. If the identifier is unknown (if, for example, it is either an unrecognized string, or the calendar is not supported by the current version of the operating system), returns NULL. Ownership follows the Create Rule.

- (`Boolean`) CFCalendarDecomposeAbsoluteTime(calendar, at, componentDesc)

Computes the components which are indicated by the componentDesc description string for the given absolute time.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
at (CFAbsoluteTime) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
componentDesc (const unsigned char) —

Options for the calculation. For valid values, see “Constants.”

Returns:

(Boolean) —

TRUE if the function is able to compute the components indicated by the componentDesc description string for the given absolute time, and fills the values to the components given in the varargs. Returns FALSE if the absolute time falls outside the defined range of the calendar, or the computation cannot be performed.

- (`Boolean`) CFCalendarGetComponentDifference(calendar, startingAT, resultAT, options, componentDesc)

Computes the difference between the two absolute times, in terms of specified calendrical components.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
startingAT (CFAbsoluteTime) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
resultAT (CFAbsoluteTime) —

Options for the calculation. For valid values, see “Constants.”
options (CFOptionFlags) —

A string that describes the components provided in the vararg parameters.
componentDesc (const unsigned char) —

Vararg parameters giving amounts of each calendrical component in the order specified by componentDesc. The amounts to add may be negative, zero, positive, or any combination thereof.

Returns:

(Boolean) —

TRUE—and in the varargs the differences—if it is possible to calculate the difference (result - starting) between resultAT and startingAT in terms of the calendrical components specified by componentDesc. Returns FALSE if either absolute time falls outside the defined range of the calendar, or the computation cannot be performed.

- (`CFIndex`) CFCalendarGetFirstWeekday(calendar)

Returns the index of first weekday for a specified calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.

Returns:

(CFIndex) —

The index of the first weekday of the specified calendar.

- (`CFStringRef`) CFCalendarGetIdentifier(calendar)

Returns the given calendar’s identifier.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.

Returns:

(CFStringRef) —

A string representation of calendar’s identifier. Calendar identifier constants can be found in CFLocaleRef. Ownership follows the Get Rule.

- (`CFRange`) CFCalendarGetMaximumRangeOfUnit(calendar, unit)

Returns the maximum range limits of the values that a specified unit can take on in a given calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
unit (CFCalendarUnit) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(CFRange) —

The maximum range limits of the values that the specified unit can take on in calendar. For example, in the Gregorian calendar the maximum ranges for the Day unit is 1-31.

- (`CFIndex`) CFCalendarGetMinimumDaysInFirstWeek(calendar)

Returns the minimum number of days in the first week of a specified calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.

Returns:

(CFIndex) —

The minimum number of days in the first week of calendar.

- (`CFRange`) CFCalendarGetMinimumRangeOfUnit(calendar, unit)

Returns the minimum range limits of the values that a specified unit can take on in a given calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
unit (CFCalendarUnit) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(CFRange) —

The minimum range limits of the values that the specified unit can take on in calendar. For example, in the Gregorian calendar the minimum ranges for the Day unit is 1-28.

- (`CFIndex`) CFCalendarGetOrdinalityOfUnit(calendar, smallerUnit, biggerUnit, at)

Returns the ordinal number of a calendrical unit within a larger unit at a specified absolute time.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
smallerUnit (CFCalendarUnit) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
biggerUnit (CFCalendarUnit) —

Options for the calculation. For valid values, see “Constants.”
at (CFAbsoluteTime) —

A string that describes the components provided in the vararg parameters.

Returns:

(CFIndex) —

The ordinal number of the calendar unit specified by smallerUnit within the calendar unit specified by biggerUnit at the absolute time at. For example, the time 00:45 is in the first hour of the day, and for units Hour and Day respectively, the result would be 1.

- (`CFRange`) CFCalendarGetRangeOfUnit(calendar, smallerUnit, biggerUnit, at)

Returns the range of values that one unit can take on within a larger unit during which a specific absolute time occurs.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
smallerUnit (CFCalendarUnit) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
biggerUnit (CFCalendarUnit) —

Options for the calculation. For valid values, see “Constants.”
at (CFAbsoluteTime) —

A string that describes the components provided in the vararg parameters.

Returns:

(CFRange) —

If the biggerUnit parameter is not logically bigger than the smallerUnit parameter in the calendar, or the given combination of units does not make sense (or is a computation which is undefined), the result is kCFNotFound.

- (`Boolean`) CFCalendarGetTimeRangeOfUnit(calendar, unit, at, startp, tip)

Returns by reference the start time and duration of a given calendar unit that contains a given absolute time.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
unit (CFCalendarUnit) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.
at (CFAbsoluteTime) —

Options for the calculation. For valid values, see “Constants.”
startp (CFAbsoluteTime) —

A string that describes the components provided in the vararg parameters.
tip (CFTimeInterval) —

Vararg parameters giving amounts of each calendrical component in the order specified by componentDesc. The amounts to add may be negative, zero, positive, or any combination thereof.

Returns:

(Boolean) —

The range of values that the calendar unit specified by smallerUnit can take on within the calendar unit specified by biggerUnit that includes the absolute time at. For example, the range the Day unit can take on in the Month in which the absolute time lies.

- (`CFTypeID`) CFCalendarGetTypeID

Returns the type identifier for the CFCalendar opaque type.

Returns:

(CFTypeID) —

If biggerUnit is not logically bigger than smallerUnit in the calendar, or the given combination of units does not make sense (or is a computation which is undefined), the result is kCFNotFound.

- (`Object`) CFCalendarSetFirstWeekday(calendar, wkdy)

Sets the first weekday for a calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
wkdy (CFIndex) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(Object) —

true if the values of startp and tip could be calculated, otherwise false.

- (`Object`) CFCalendarSetLocale(calendar, locale)

Sets the locale for a calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
locale (CFLocaleRef) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(Object) —

The type identifier for the CFCalendar opaque type.

- (`nil`) CFCalendarSetMinimumDaysInFirstWeek(calendar, mwd)

Sets the minimum number of days in the first week of a specified calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
mwd (CFIndex) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(nil)

- (`nil`) CFCalendarSetTimeZone(calendar, tz)

Sets the time zone for a calendar.

Parameters:

calendar (CFCalendarRef) —

The calendar to use for the computation.
tz (CFTimeZoneRef) —

A reference to an absolute time. On input, points to the absolute time to which components are to be added; on output, points to the result of the computation.

Returns:

(nil)

- (`Object`) CFCharacterSetAddCharactersInRange(theSet, theRange)

Adds a given range to a character set.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.
theRange (CFRange) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(Object) —

A new empty mutable character set. Ownership follows the Create Rule.

- (`Object`) CFCharacterSetAddCharactersInString(theSet, theString)

Adds the characters in a given string to a character set.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.
theString (CFStringRef) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(Object) —

A new mutable character set containing the same characters as theSet. Ownership follows the Create Rule.

- (`CFDataRef`) CFCharacterSetCreateBitmapRepresentation(alloc, theSet)

Creates a new immutable data with the bitmap representation from the given character set.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theSet (CFCharacterSetRef) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(CFDataRef) —

A new CFData object containing a bitmap representation of theSet. Ownership follows the Create Rule.

- (`CFCharacterSetRef`) CFCharacterSetCreateCopy(alloc, theSet)

Creates a new character set with the values from a given character set.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theSet (CFCharacterSetRef) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(CFCharacterSetRef) —

A new character set that is a copy of theSet. Ownership follows the Create Rule.

- (`CFCharacterSetRef`) CFCharacterSetCreateInvertedSet(alloc, theSet)

Creates a new immutable character set that is the invert of the specified character set.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theSet (CFCharacterSetRef) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(CFCharacterSetRef) —

A new character set that is the invert of theSet. Ownership follows the Create Rule.

- (`CFMutableCharacterSetRef`) CFCharacterSetCreateMutable(alloc)

Creates a new empty mutable character set.

Parameters:

alloc (CFAllocatorRef) —

The character set to modify.

Returns:

(CFMutableCharacterSetRef)

- (`CFMutableCharacterSetRef`) CFCharacterSetCreateMutableCopy(alloc, theSet)

Creates a new mutable character set with the values from another character set.

Parameters:

alloc (CFAllocatorRef) —

The character set to modify.
theSet (CFCharacterSetRef) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(CFMutableCharacterSetRef)

- (`CFCharacterSetRef`) CFCharacterSetCreateWithBitmapRepresentation(alloc, theData)

Creates a new immutable character set with the bitmap representation specified by given data.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theData (CFDataRef) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(CFCharacterSetRef) —

A new character set containing the indicated characters from theData. Ownership follows the Create Rule.

- (`CFCharacterSetRef`) CFCharacterSetCreateWithCharactersInRange(alloc, theRange)

Creates a new character set with the values from the given range of Unicode characters.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theRange (CFRange) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(CFCharacterSetRef) —

A new character set that contains a contiguous range of Unicode characters. Ownership follows the Create Rule.

- (`CFCharacterSetRef`) CFCharacterSetCreateWithCharactersInString(alloc, theString)

Creates a new character set with the values in the given string.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theString (CFStringRef) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(CFCharacterSetRef) —

A new character set containing the characters from theString. Ownership follows the Create Rule.

- (`CFCharacterSetRef`) CFCharacterSetGetPredefined(theSetIdentifier)

Returns a predefined character set.

Parameters:

theSetIdentifier (CFCharacterSetPredefinedSet) —

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

Returns:

(CFCharacterSetRef) —

A predefined character set. This instance is owned by Core Foundation.

- (`CFTypeID`) CFCharacterSetGetTypeID

Returns the type identifier of the CFCharacterSet opaque type.

Returns:

(CFTypeID) —

The type identifier of the CFCharacterSet opaque type.

- (`Boolean`) CFCharacterSetHasMemberInPlane(theSet, thePlane)

Reports whether or not a character set contains at least one member character in the specified plane.

Parameters:

theSet (CFCharacterSetRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
thePlane (CFIndex) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(Boolean) —

true if at least one member character is in the specified plane, otherwise false.

- (`nil`) CFCharacterSetIntersect(theSet, theOtherSet)

Forms an intersection of two character sets.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.
theOtherSet (CFCharacterSetRef) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(nil)

- (`nil`) CFCharacterSetInvert(theSet)

Inverts the content of a given character set.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.

Returns:

(nil)

- (`Boolean`) CFCharacterSetIsCharacterMember(theSet, theChar)

Reports whether or not a given Unicode character is in a character set.

Parameters:

theSet (CFCharacterSetRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theChar (UniChar) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(Boolean) —

true if theSet contains theChar, otherwise false.

- (`Boolean`) CFCharacterSetIsLongCharacterMember(theSet, theChar)

Reports whether or not a given UTF-32 character is in a character set.

Parameters:

theSet (CFCharacterSetRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theChar (UTF32Char) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(Boolean) —

true if theSet contains theChar, otherwise false.

- (`Boolean`) CFCharacterSetIsSupersetOfSet(theSet, theOtherset)

Reports whether or not a character set is a superset of another set.

Parameters:

theSet (CFCharacterSetRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theOtherset (CFCharacterSetRef) —

The set from which to create a bitmap representation. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format.

Returns:

(Boolean) —

true if theSet is a superset of theOtherSet, otherwise false.

- (`nil`) CFCharacterSetRemoveCharactersInRange(theSet, theRange)

Removes a given range of Unicode characters from a character set.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.
theRange (CFRange) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(nil)

- (`nil`) CFCharacterSetRemoveCharactersInString(theSet, theString)

Removes the characters in a given string from a character set.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.
theString (CFStringRef) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(nil)

- (`nil`) CFCharacterSetUnion(theSet, theOtherSet)

Forms the union of two character sets.

Parameters:

theSet (CFMutableCharacterSetRef) —

The character set to modify.
theOtherSet (CFCharacterSetRef) —

The range to add to the character set. The range is specified in 32-bits in UTF-32 format, and must lie within the valid Unicode character range (from 0x00000 to 0x10FFFF).

Returns:

(nil)

- (`CFSwappedFloat64`) CFConvertDoubleHostToSwapped(arg)

Converts a 64-bit double from the host’s native byte order to a platform-independent format.

Parameters:

arg (Float) —

The real value to convert.

Returns:

(CFSwappedFloat64) —

A structure holding the real value in a canonical byte order.

- (`Float`) CFConvertDoubleSwappedToHost(arg)

Converts a 64-bit double from a platform-independent format to the host’s native byte order.

Parameters:

arg (CFSwappedFloat64) —

The real value to convert.

Returns:

(Float) —

The real value in the host’s native format.

- (`CFSwappedFloat32`) CFConvertFloat32HostToSwapped(arg)

Converts a 32-bit float from the host’s native byte order to a platform-independent format.

Parameters:

arg (Float32) —

The real value to convert.

Returns:

(CFSwappedFloat32) —

A structure holding the real value in a canonical byte order.

- (`Float32`) CFConvertFloat32SwappedToHost(arg)

Converts a 32-bit float from a platform-independent format to the host’s native byte order.

Parameters:

arg (CFSwappedFloat32) —

The real value to convert.

Returns:

(Float32) —

The real value in the host’s native format.

- (`CFSwappedFloat64`) CFConvertFloat64HostToSwapped(arg)

Converts a 64-bit float from the host’s native byte order to a platform-independent format.

Parameters:

arg (Float64) —

The real value to convert.

Returns:

(CFSwappedFloat64) —

A structure holding the real value in a canonical byte order.

- (`Float64`) CFConvertFloat64SwappedToHost(arg)

Converts a 64-bit float from a platform-independent format to the host’s native byte order.

Parameters:

arg (CFSwappedFloat64) —

The real value to convert.

Returns:

(Float64) —

The real value in the host’s native format.

- (`CFSwappedFloat32`) CFConvertFloatHostToSwapped(arg)

Converts a 32-bit float from the host’s native byte order to a platform-independent format.

Parameters:

arg (Float) —

The real value to convert.

Returns:

(CFSwappedFloat32) —

A structure holding the real value in a canonical byte order.

- (`Float`) CFConvertFloatSwappedToHost(arg)

Converts a 32-bit float from a platform-independent format to the host’s native byte order.

Parameters:

arg (CFSwappedFloat32) —

The real value to convert.

Returns:

(Float) —

The real value in the host’s native format.

- (`CFStringRef`) CFCopyDescription(cf)

Returns a textual description of a Core Foundation object.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFStringRef) —

A string that contains a description of cf. Ownership follows the Create Rule.

- (`CFStringRef`) CFCopyLocalizedString(key, comment)

Searches the default strings file Localizable.strings for the string associated with the specified key.

Parameters:

key (CFStringRef) —

The bundle whose resource map is referenced by refNum.
comment (const char) —

The reference number for a resource map to close.

Returns:

(CFStringRef)

- (`CFStringRef`) CFCopyLocalizedStringFromTable(key, tableName, comment)

Searches the specified strings file for the string associated with the specified key.

Parameters:

key (CFStringRef) —

The bundle whose resource map is referenced by refNum.
tableName (CFStringRef) —

The reference number for a resource map to close.
comment (const char) —

The bundle to examine.

Returns:

(CFStringRef)

- (`CFStringRef`) CFCopyLocalizedStringFromTableInBundle(key, tableName, bundle, comment)

Returns a localized version of the specified string.

Parameters:

key (CFStringRef) —

The bundle whose resource map is referenced by refNum.
tableName (CFStringRef) —

The reference number for a resource map to close.
bundle (CFBundleRef) —

The bundle to examine.
comment (const char) —

The name of bundle’s auxiliary executable code.

Returns:

(CFStringRef)

- (`CFStringRef`) CFCopyLocalizedStringWithDefaultValue(key, tableName, bundle, value, comment)

Returns a localized version of a localization string.

Parameters:

key (CFStringRef) —

The bundle whose resource map is referenced by refNum.
tableName (CFStringRef) —

The reference number for a resource map to close.
bundle (CFBundleRef) —

The bundle to examine.
value (CFStringRef) —

The name of bundle’s auxiliary executable code.
comment (const char) —

The bundle to examine.

Returns:

(CFStringRef)

- (`CFStringRef`) CFCopyTypeIDDescription(type_id)

Returns a textual description of a Core Foundation type, as identified by its type ID, which can be used when debugging.

Parameters:

type_id (CFTypeID) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFStringRef) —

A string containing a type description. Ownership follows the Create Rule.

- (`Object`) CFDataAppendBytes(theData, bytes, length)

Appends the bytes from a byte buffer to the contents of a CFData object.

Parameters:

theData (CFMutableDataRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
bytes (const UInt8) —

A pointer to the buffer of bytes to be added to theData.
length (CFIndex) —

The number of bytes in the byte buffer bytes.

Returns:

(Object) —

A CFMutableData object or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFDataRef`) CFDataCreate(allocator, bytes, length)

Creates an immutable CFData object using data copied from a specified byte buffer.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
bytes (const UInt8) —

A pointer to the byte buffer that contains the raw data to be copied into theData.
length (CFIndex) —

The number of bytes in the buffer (bytes).

Returns:

(CFDataRef) —

A new CFData object, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFDataRef`) CFDataCreateCopy(allocator, theData)

Creates an immutable copy of a CFData object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theData (CFDataRef) —

A pointer to the byte buffer that contains the raw data to be copied into theData.

Returns:

(CFDataRef) —

An immutable copy of theData, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFMutableDataRef`) CFDataCreateMutable(allocator, capacity)

Creates an empty CFMutableData object.

Parameters:

allocator (CFAllocatorRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
capacity (CFIndex) —

A pointer to the buffer of bytes to be added to theData.

Returns:

(CFMutableDataRef) —

A CFMutableData object that has the same contents as the original object. Returns NULL if there was a problem copying the object. Ownership follows the Create Rule.

- (`CFMutableDataRef`) CFDataCreateMutableCopy(allocator, capacity, theData)

Creates a CFMutableData object by copying another CFData object.

Parameters:

allocator (CFAllocatorRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
capacity (CFIndex) —

A pointer to the buffer of bytes to be added to theData.
theData (CFDataRef) —

The number of bytes in the byte buffer bytes.

Returns:

(CFMutableDataRef) —

A pointer to the bytes associated with theData.

- (`CFDataRef`) CFDataCreateWithBytesNoCopy(allocator, bytes, length, bytesDeallocator)

Creates an immutable CFData object from an external (client-owned) byte buffer.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
bytes (const UInt8) —

A pointer to the byte buffer that contains the raw data to be copied into theData.
length (CFIndex) —

The number of bytes in the buffer (bytes).
bytesDeallocator (CFAllocatorRef) —

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

Returns:

(CFDataRef) —

A new CFData object, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`nil`) CFDataDeleteBytes(theData, range)

Deletes the bytes in a CFMutableData object within a specified range.

Parameters:

theData (CFMutableDataRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
range (CFRange) —

A pointer to the buffer of bytes to be added to theData.

Returns:

(nil)

- (`CFRange`) CFDataFind(theData, dataToFind, searchRange, compareOptions)

Finds and returns the range within a data object of the first occurrence of the given data, within a given range, subject to any given options.

Parameters:

theData (CFDataRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
dataToFind (CFDataRef) —

A pointer to the byte buffer that contains the raw data to be copied into theData.
searchRange (CFRange) —

The number of bytes in the buffer (bytes).
compareOptions (CFDataSearchFlags) —

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

Returns:

(CFRange) —

The range representing the location and length of dataToFind within searchRange, modulo the options in compareOptions. The range returned is relative to the start of the searched data, not the passed-in search range. Returns 0 if dataToFind is not found.

- (`const`) CFDataGetBytePtr(theData)

Returns a read-only pointer to the bytes of a CFData object.

Parameters:

theData (CFDataRef) —

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

Returns:

(const) —

A read-only pointer to the bytes associated with theData.

- (`Object`) CFDataGetBytes(theData, range, buffer)

Copies the byte contents of a CFData object to an external buffer.

Parameters:

theData (CFDataRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
range (CFRange) —

A pointer to the byte buffer that contains the raw data to be copied into theData.
buffer (UInt8) —

The number of bytes in the buffer (bytes).

Returns:

(Object) —

An index that specifies the number of bytes in theData.

- (`CFIndex`) CFDataGetLength(theData)

Returns the number of bytes contained by a CFData object.

Parameters:

theData (CFDataRef) —

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

Returns:

(CFIndex) —

The type identifier for the CFData opaque type.

- (`UInt8`) CFDataGetMutableBytePtr(theData)

Returns a pointer to a mutable byte buffer of a CFMutableData object.

Parameters:

theData (CFMutableDataRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.

Returns:

(UInt8)

- (`CFTypeID`) CFDataGetTypeID

Returns the type identifier for the CFData opaque type.

Returns:

(CFTypeID)

- (`nil`) CFDataIncreaseLength(theData, extraLength)

Increases the length of a CFMutableData object's internal byte buffer, zero-filling the extension to the buffer.

Parameters:

theData (CFMutableDataRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
extraLength (CFIndex) —

A pointer to the buffer of bytes to be added to theData.

Returns:

(nil)

- (`nil`) CFDataReplaceBytes(theData, range, newBytes, newLength)

Replaces those bytes in a CFMutableData object that fall within a specified range with other bytes.

Parameters:

theData (CFMutableDataRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
range (CFRange) —

A pointer to the buffer of bytes to be added to theData.
newBytes (const UInt8) —

The number of bytes in the byte buffer bytes.
newLength (CFIndex) —

The CFAllocator object to be used to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(nil)

- (`nil`) CFDataSetLength(theData, length)

Resets the length of a CFMutableData object's internal byte buffer.

Parameters:

theData (CFMutableDataRef) —

A CFMutableData object. If you pass an immutable CFData object, the behavior is not defined.
length (CFIndex) —

A pointer to the buffer of bytes to be added to theData.

Returns:

(nil)

- (`CFComparisonResult`) CFDateCompare(theDate, otherDate, context)

Compares two CFDate objects and returns a comparison result.

Parameters:

theDate (CFDateRef) —

The date to compare to otherDate.
otherDate (CFDateRef) —

The date to compare to theDate.
context (Object) —

Unused. Pass NULL.

Returns:

(CFComparisonResult) —

A Comparison Results value that indicates whether theDate is equal to, less than, or greater than otherDate.

- (`CFDateRef`) CFDateCreate(allocator, at)

Creates a CFDate object given an absolute time.

Parameters:

allocator (CFAllocatorRef) —

The date to compare to otherDate.
at (CFAbsoluteTime) —

The date to compare to theDate.

Returns:

(CFDateRef) —

A date object that represents the absolute time at. The caller is responsible for releasing the CFDate object using CFRelease.

- (`CFTypeRef`) CFDateFormatterCopyProperty(formatter, key)

Returns a copy of a date formatter’s value for a given key.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.
key (CFStringRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.

Returns:

(CFTypeRef) —

A CFType object that is a copy of the property value for key, or NULL if there is no value specified for key. Ownership follows the Create Rule.

- (`CFDateFormatterRef`) CFDateFormatterCreate(allocator, locale, dateStyle, timeStyle)

Creates a new CFDateFormatter object, localized to the given locale, which will format dates to the given date and time styles.

Parameters:

allocator (CFAllocatorRef) —

The date formatter to examine.
locale (CFLocaleRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
dateStyle (CFDateFormatterStyle) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
timeStyle (CFDateFormatterStyle) —

The locale to use for localization. If NULL uses the default system local. Use CFLocaleCopyCurrent to specify the locale of the current user.

Returns:

(CFDateFormatterRef) —

A new date formatter, localized to the given locale, which will format dates to the given date and time styles. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFDateFormatterCreateDateFormatFromTemplate(allocator, template, options, locale)

Returns a localized date format string representing the given date format components arranged appropriately for the specified locale.

Parameters:

allocator (CFAllocatorRef) —

The date formatter to examine.
template (CFStringRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
options (CFOptionFlags) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
locale (CFLocaleRef) —

The locale to use for localization. If NULL uses the default system local. Use CFLocaleCopyCurrent to specify the locale of the current user.

Returns:

(CFStringRef) —

A localized date format string representing the date format components given in template, arranged appropriately for the locale specified by locale. Ownership follows the Create Rule.

- (`CFDateRef`) CFDateFormatterCreateDateFromString(allocator, formatter, string, rangep)

Returns a date object representing a given string.

Parameters:

allocator (CFAllocatorRef) —

The date formatter to examine.
formatter (CFDateFormatterRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
string (CFStringRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
rangep (CFRange) —

The locale to use for localization. If NULL uses the default system local. Use CFLocaleCopyCurrent to specify the locale of the current user.

Returns:

(CFDateRef) —

The returned string may not contain exactly those components given in template, but may—for example—have locale-specific adjustments applied.

- (`CFStringRef`) CFDateFormatterCreateStringWithAbsoluteTime(allocator, formatter, at)

Returns a string representation of the given absolute time using the specified date formatter.

Parameters:

allocator (CFAllocatorRef) —

The date formatter to examine.
formatter (CFDateFormatterRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
at (CFAbsoluteTime) —

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

Returns:

(CFStringRef) —

A new date that represents string, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFDateFormatterCreateStringWithDate(allocator, formatter, date)

Returns a string representation of the given date using the specified date formatter.

Parameters:

allocator (CFAllocatorRef) —

The date formatter to examine.
formatter (CFDateFormatterRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
date (CFDateRef) —

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

Returns:

(CFStringRef) —

A new string that represents at in the specified format. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`Boolean`) CFDateFormatterGetAbsoluteTimeFromString(formatter, string, rangep, atp)

Returns an absolute time object representing a given string.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.
string (CFStringRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
rangep (CFRange) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
atp (CFAbsoluteTime) —

The locale to use for localization. If NULL uses the default system local. Use CFLocaleCopyCurrent to specify the locale of the current user.

Returns:

(Boolean) —

A new string that represents date in the specified format. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFDateFormatterStyle`) CFDateFormatterGetDateStyle(formatter)

Returns the date style used to create the given date formatter object.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.

Returns:

(CFDateFormatterStyle) —

true if the string was parsed successfully, otherwise false.

- (`CFStringRef`) CFDateFormatterGetFormat(formatter)

Returns a format string for the given date formatter object.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.

Returns:

(CFStringRef) —

The date style used to create formatter.

- (`CFLocaleRef`) CFDateFormatterGetLocale(formatter)

Returns the locale object used to create the given date formatter object.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.

Returns:

(CFLocaleRef) —

The format string for formatter as was specified by calling the CFDateFormatterSetFormat function, or derived from the date formatter’s date or time styles. Ownership follows the Get Rule.

- (`CFDateFormatterStyle`) CFDateFormatterGetTimeStyle(formatter)

Returns the time style used to create the given date formatter object.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.

Returns:

(CFDateFormatterStyle) —

The locale object used to create formatter. Ownership follows the Get Rule.

- (`CFTypeID`) CFDateFormatterGetTypeID

Returns the type identifier for CFDateFormatter.

Returns:

(CFTypeID) —

The time style used to create formatter.

- (`Object`) CFDateFormatterSetFormat(formatter, formatString)

Sets the format string of the given date formatter to the specified value.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.
formatString (CFStringRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.

Returns:

(Object) —

The type identifier for the CFDateFormatter opaque type.

- (`nil`) CFDateFormatterSetProperty(formatter, key, value)

Sets a date formatter property using a key-value pair.

Parameters:

formatter (CFDateFormatterRef) —

The date formatter to examine.
key (CFStringRef) —

The property key for the value to obtain. See “Date Formatter Property Keys” for a description of possible values for this parameter.
value (CFTypeRef) —

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

Returns:

(nil)

- (`CFAbsoluteTime`) CFDateGetAbsoluteTime(theDate)

Returns a CFDate object’s absolute time.

Parameters:

theDate (CFDateRef) —

The date to compare to otherDate.

Returns:

(CFAbsoluteTime) —

The absolute time of theDate.

- (`CFTimeInterval`) CFDateGetTimeIntervalSinceDate(theDate, otherDate)

Returns the number of elapsed seconds between the given CFDate objects.

Parameters:

theDate (CFDateRef) —

The date to compare to otherDate.
otherDate (CFDateRef) —

The date to compare to theDate.

Returns:

(CFTimeInterval) —

The number of elapsed seconds between theDate and otherDate. The result is positive if theDate is later than otherDate.

- (`CFTypeID`) CFDateGetTypeID

Returns the type identifier for the CFDate opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFDate opaque type.

- (`Object`) CFDictionaryAddValue(theDict, key, value)

Adds a key-value pair to a dictionary if the specified key is not already present.

Parameters:

theDict (CFMutableDictionaryRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.
key (Object) —

The key for the value to add to the dictionary—a CFType object or a pointer value. The key is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback. If a key which matches key is already present in the dictionary, this function does nothing (“add if absent”).
value (Object) —

A CFType object or a pointer value to add to the dictionary. The value is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback.

Returns:

(Object) —

A new dictionary, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFDictionaryApplyFunction(theDict, applier, context)

Calls a function once for each key-value pair in a dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
applier (CFDictionaryApplierFunction) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.
context (Object) —

A pointer-sized program-defined value, which is passed as the third parameter to the applier function, but is otherwise unused by this function. The value must be appropriate for the applier function.

Returns:

(Object) —

true if key is in the dictionary, otherwise false.

- (`Boolean`) CFDictionaryContainsKey(theDict, key)

Returns a Boolean value that indicates whether a given key is in a dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
key (Object) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(Boolean) —

true if value is in the dictionary, otherwise false.

- (`Boolean`) CFDictionaryContainsValue(theDict, value)

Returns a Boolean value that indicates whether a given value is in a dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
value (Object) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(Boolean) —

A new dictionary, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFDictionaryRef`) CFDictionaryCreate(allocator, keys, values, numValues, keyCallBacks, valueCallBacks)

Creates an immutable dictionary containing the specified key-value pairs.

Parameters:

allocator (CFAllocatorRef) —

The dictionary to operate upon.
keys (Pointer) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.
values (Pointer) —

A pointer-sized program-defined value, which is passed as the third parameter to the applier function, but is otherwise unused by this function. The value must be appropriate for the applier function.
numValues (CFIndex) —

The dictionary to examine.
keyCallBacks (const CFDictionaryKeyCallBacks) —

The key for which to find matches in theDict. The key hash and equal callbacks provided when the dictionary was created, are used to compare. If the hash callback is NULL, key is treated as a pointer and converted to an integer. If the equal callback is NULL, pointer equality (in C, ==) is used. If key, or any of the keys in the dictionary, is not understood by the equal callback, the behavior is undefined.
valueCallBacks (const CFDictionaryValueCallBacks) —

The dictionary to examine.

Returns:

(CFDictionaryRef) —

A new dictionary that contains the same key-value pairs as theDict, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFDictionaryRef`) CFDictionaryCreateCopy(allocator, theDict)

Creates and returns a new immutable dictionary with the key-value pairs of another dictionary.

Parameters:

allocator (CFAllocatorRef) —

The dictionary to operate upon.
theDict (CFDictionaryRef) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFDictionaryRef) —

The number of number of key-value pairs in theDict.

- (`CFMutableDictionaryRef`) CFDictionaryCreateMutable(allocator, capacity, keyCallBacks, valueCallBacks)

Creates a new mutable dictionary.

Parameters:

allocator (CFAllocatorRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.
capacity (CFIndex) —

The key for the value to add to the dictionary—a CFType object or a pointer value. The key is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback. If a key which matches key is already present in the dictionary, this function does nothing (“add if absent”).
keyCallBacks (const CFDictionaryKeyCallBacks) —

A CFType object or a pointer value to add to the dictionary. The value is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback.
valueCallBacks (const CFDictionaryValueCallBacks) —

The allocator to use to allocate memory for the new dictionary and its storage for key-value pairs. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFMutableDictionaryRef) —

A new dictionary that contains the same values as theDict. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFMutableDictionaryRef`) CFDictionaryCreateMutableCopy(allocator, capacity, theDict)

Creates a new mutable dictionary with the key-value pairs from another dictionary.

Parameters:

allocator (CFAllocatorRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.
capacity (CFIndex) —

The key for the value to add to the dictionary—a CFType object or a pointer value. The key is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback. If a key which matches key is already present in the dictionary, this function does nothing (“add if absent”).
theDict (CFDictionaryRef) —

A CFType object or a pointer value to add to the dictionary. The value is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback.

Returns:

(CFMutableDictionaryRef)

- (`CFIndex`) CFDictionaryGetCount(theDict)

Returns the number of key-value pairs in a dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.

Returns:

(CFIndex) —

Returns 1 if a matching key is used by the dictionary, otherwise 0.

- (`CFIndex`) CFDictionaryGetCountOfKey(theDict, key)

Returns the number of times a key occurs in a dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
key (Object) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFIndex) —

The number of times the value occurs in theDict.

- (`CFIndex`) CFDictionaryGetCountOfValue(theDict, value)

Counts the number of times a given value occurs in the dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
value (Object) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(CFIndex) —

The type identifier for the CFDictionary opaque type.

- (`Object`) CFDictionaryGetKeysAndValues(theDict, keys, values)

Fills two buffers with the keys and values from a dictionary.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
keys (Pointer) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.
values (Pointer) —

A pointer-sized program-defined value, which is passed as the third parameter to the applier function, but is otherwise unused by this function. The value must be appropriate for the applier function.

Returns:

(Object) —

The value associated with key in theDict, or NULL if no key-value pair matching key exists. Since NULL is also a valid value in some dictionaries, use CFDictionaryGetValueIfPresent to distinguish between a value that is not found, and a NULL value. If the value is a Core Foundation object, ownership follows the Get Rule.

- (`CFTypeID`) CFDictionaryGetTypeID

Returns the type identifier for the CFDictionary opaque type.

Returns:

(CFTypeID) —

true if a matching key was found, otherwise false.

- (`const`) CFDictionaryGetValue(theDict, key)

Returns the value associated with a given key.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
key (Object) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Returns:

(const)

- (`Boolean`) CFDictionaryGetValueIfPresent(theDict, key, value)

Returns a Boolean value that indicates whether a given value for a given key is in a dictionary, and returns that value indirectly if it exists.

Parameters:

theDict (CFDictionaryRef) —

The dictionary to operate upon.
key (Object) —

The callback function to call once for each key-value pair in theDict. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.
value (Pointer) —

A pointer-sized program-defined value, which is passed as the third parameter to the applier function, but is otherwise unused by this function. The value must be appropriate for the applier function.

Returns:

(Boolean)

- (`nil`) CFDictionaryRemoveAllValues(theDict)

Removes all the key-value pairs from a dictionary, making it empty.

Parameters:

theDict (CFMutableDictionaryRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFDictionaryRemoveValue(theDict, key)

Removes a key-value pair.

Parameters:

theDict (CFMutableDictionaryRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.
key (Object) —

The key for the value to add to the dictionary—a CFType object or a pointer value. The key is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback. If a key which matches key is already present in the dictionary, this function does nothing (“add if absent”).

Returns:

(nil)

- (`nil`) CFDictionaryReplaceValue(theDict, key, value)

Replaces a value corresponding to a given key.

Parameters:

theDict (CFMutableDictionaryRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.
key (Object) —

The key for the value to add to the dictionary—a CFType object or a pointer value. The key is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback. If a key which matches key is already present in the dictionary, this function does nothing (“add if absent”).
value (Object) —

A CFType object or a pointer value to add to the dictionary. The value is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback.

Returns:

(nil)

- (`nil`) CFDictionarySetValue(theDict, key, value)

Sets the value corresponding to a given key.

Parameters:

theDict (CFMutableDictionaryRef) —

The dictionary to modify. If the dictionary is a fixed-capacity dictionary and it is full before this operation, the behavior is undefined.
key (Object) —

The key for the value to add to the dictionary—a CFType object or a pointer value. The key is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback. If a key which matches key is already present in the dictionary, this function does nothing (“add if absent”).
value (Object) —

A CFType object or a pointer value to add to the dictionary. The value is retained by the dictionary using the retain callback provided when the dictionary was created, so must be of the type expected by the callback.

Returns:

(nil)

- (`Boolean`) CFEqual(cf1, cf2)

Determines whether two Core Foundation objects are considered equal.

Parameters:

cf1 (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.
cf2 (CFTypeRef) —

An integer of type CFTypeID that uniquely identifies a Core Foundation opaque type.

Returns:

(Boolean) —

true if cf1 and cf2 are of the same type and considered equal, otherwise false.

- (`CFStringRef`) CFErrorCopyDescription(err)

Returns a human-presentable description for a given error.

Parameters:

err (CFErrorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFStringRef) —

A localized, human-presentable description of err. This function never returns NULL. Ownership follows the Create Rule.

- (`CFStringRef`) CFErrorCopyFailureReason(err)

Returns a human-presentable failure reason for a given error.

Parameters:

err (CFErrorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFStringRef) —

A localized, human-presentable failure reason for err, or NULL if no user-presentable string is available. Ownership follows the Create Rule.

- (`CFStringRef`) CFErrorCopyRecoverySuggestion(err)

Returns a human presentable recovery suggestion for a given error.

Parameters:

err (CFErrorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFStringRef) —

A localized, human-presentable recovery suggestion for err, or NULL if no user-presentable string is available. Ownership follows the Create Rule.

- (`CFDictionaryRef`) CFErrorCopyUserInfo(err)

Returns the user info dictionary for a given CFError.

Parameters:

err (CFErrorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFDictionaryRef) —

A dictionary containing the same keys and values as in the userInfo dictionary err was created with. Returns an empty dictionary if NULL was supplied to the create function. Ownership follows the Create Rule.

- (`CFErrorRef`) CFErrorCreate(allocator, domain, code, userInfo)

Creates a new CFError object.

Parameters:

allocator (CFAllocatorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.
domain (CFStringRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.
code (CFIndex) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.
userInfo (CFDictionaryRef) —

The error to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFErrorRef) —

A new CFError object. Ownership follows the Create Rule.

- (`CFErrorRef`) CFErrorCreateWithUserInfoKeysAndValues(allocator, domain, code, userInfoKeys, userInfoValues, numUserInfoValues)

Creates a new CFError object using given keys and values to create the user info dictionary.

Parameters:

allocator (CFAllocatorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.
domain (CFStringRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.
code (CFIndex) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.
userInfoKeys (Object) —

The error to examine. If this is not a valid CFError, the behavior is undefined.
userInfoValues (Object) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
numUserInfoValues (CFIndex) —

A CFString that identifies the error domain. If this reference is NULL or is otherwise not a valid CFString, the behavior is undefined.

Returns:

(CFErrorRef) —

A new CFError object. Ownership follows the Create Rule.

- (`CFIndex`) CFErrorGetCode(err)

Returns the error code for a given CFError.

Parameters:

err (CFErrorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFIndex) —

The error code of err.

- (`CFStringRef`) CFErrorGetDomain(err)

Returns the error domain for a given CFError.

Parameters:

err (CFErrorRef) —

The CFError to examine. If this is not a valid CFError, the behavior is undefined.

Returns:

(CFStringRef) —

The error domain for err. Ownership follows the Get Rule.

- (`CFTypeID`) CFErrorGetTypeID

Returns the type identifier for the CFError opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFError opaque type.

- (`CFFileDescriptorRef`) CFFileDescriptorCreate(allocator, fd, closeOnInvalidate, callout, context)

Creates a new CFFileDescriptor.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
fd (CFFileDescriptorNativeDescriptor) —

The file descriptor for the new CFFileDescriptor.
closeOnInvalidate (Boolean) —

true if the new CFFileDescriptor should close fd when it is invalidated, otherwise false.
callout (CFFileDescriptorCallBack) —

The CFFileDescriptorCallBack for the new CFFileDescriptor.
context (const CFFileDescriptorContext) —

Contextual information for the new CFFileDescriptor.

Returns:

(CFFileDescriptorRef) —

A new CFFileDescriptor or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFRunLoopSourceRef`) CFFileDescriptorCreateRunLoopSource(allocator, f, order)

Creates a new runloop source for a given CFFileDescriptor.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
f (CFFileDescriptorRef) —

The file descriptor for the new CFFileDescriptor.
order (CFIndex) —

true if the new CFFileDescriptor should close fd when it is invalidated, otherwise false.

Returns:

(CFRunLoopSourceRef) —

A new runloop source for f, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`Object`) CFFileDescriptorDisableCallBacks(f, callBackTypes)

Disables callbacks for a given CFFileDescriptor.

Parameters:

f (CFFileDescriptorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
callBackTypes (CFOptionFlags) —

The file descriptor for the new CFFileDescriptor.

Returns:

(Object) —

The native file descriptor for f.

- (`Object`) CFFileDescriptorEnableCallBacks(f, callBackTypes)

Enables callbacks for a given CFFileDescriptor.

Parameters:

f (CFFileDescriptorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
callBackTypes (CFOptionFlags) —

The file descriptor for the new CFFileDescriptor.

Returns:

(Object) —

The type identifier for the CFFileDescriptor opaque type.

- (`Object`) CFFileDescriptorGetContext(f, context)

Gets the context for a given CFFileDescriptor.

Parameters:

f (CFFileDescriptorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFFileDescriptorContext) —

The file descriptor for the new CFFileDescriptor.

Returns:

(Object) —

true if the native file descriptor for f is valid, otherwise false.

- (`CFFileDescriptorNativeDescriptor`) CFFileDescriptorGetNativeDescriptor(f)

Returns the native file descriptor for a given CFFileDescriptor.

Parameters:

f (CFFileDescriptorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFFileDescriptorNativeDescriptor)

- (`CFTypeID`) CFFileDescriptorGetTypeID

Returns the type identifier for the CFFileDescriptor opaque type.

Returns:

(CFTypeID)

- (`nil`) CFFileDescriptorInvalidate(f)

Invalidates a CFFileDescriptor object.

Parameters:

f (CFFileDescriptorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(nil)

- (`Boolean`) CFFileDescriptorIsValid(f)

Returns a Boolean value that indicates whether the native file descriptor for a given CFFileDescriptor is valid.

Parameters:

f (CFFileDescriptorRef) —

The allocator to use to allocate memory for the new file descriptor object. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(Boolean)

- (`CFIndex`) CFFTPCreateParsedResourceListing(alloc, buffer, bufferLength, parsed)

Parses an FTP listing to a dictionary.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the dictionary. Pass NULL or kCFAllocatorDefault to use the current default allocator.
buffer (const UInt8) —

A pointer to a buffer holding zero or more lines of resource listing.
bufferLength (CFIndex) —

The length in bytes of the buffer pointed to by buffer.
parsed (CFDictionaryRef) —

Upon return, contains a dictionary containing the parsed resource information. If parsing fails, a NULL pointer is returned.

Returns:

(CFIndex) —

The number of bytes parsed, 0 if no bytes were available for parsing, or -1 if parsing failed.

- (`CFAllocatorRef`) CFGetAllocator(cf)

Returns the allocator used to allocate a Core Foundation object.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFAllocatorRef) —

The allocator used to allocate memory for cf.

- (`CFIndex`) CFGetRetainCount(cf)

Returns the reference count of a Core Foundation object.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFIndex) —

A number representing the reference count of cf.

- (`CFTypeID`) CFGetTypeID(cf)

Returns the unique identifier of an opaque type to which a Core Foundation object belongs.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFTypeID) —

A value of type CFTypeID that identifies the opaque type of cf.

- (`CFAbsoluteTime`) CFGregorianDateGetAbsoluteTime(gdate, tz)

Converts a Gregorian date value into an absolute time value.

Parameters:

gdate (CFGregorianDate) —

The absolute time to which the interval is added.
tz (CFTimeZoneRef) —

The time zone to use for time correction. Pass NULL for GMT.

Returns:

(CFAbsoluteTime) —

The absolute time equivalent of gdate.

- (`Boolean`) CFGregorianDateIsValid(gdate, unitFlags)

Checks the specified fields of a CFGregorianDate structure for valid values.

Parameters:

gdate (CFGregorianDate) —

The absolute time to which the interval is added.
unitFlags (CFOptionFlags) —

The time zone to use for time correction. Pass NULL for GMT.

Returns:

(Boolean) —

true if the specified fields are valid, otherwise false.

- (`CFHashCode`) CFHash(cf)

Returns a code that can be used to identify an object in a hashing structure.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFHashCode) —

An integer of type CFHashCode that represents a hashing value for cf.

- (`Object`) CFHostCancelInfoResolution(theHost, info)

Cancels the resolution of a host.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
info (CFHostInfoType) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(Object) —

A valid CFHost object or NULL if the copy could not be created. The new host contains a copy of all previously resolved data from the original host. Ownership follows the Create Rule.

- (`CFHostRef`) CFHostCreateCopy(alloc, host)

Creates a new host object by copying.

Parameters:

alloc (CFAllocatorRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
host (CFHostRef) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(CFHostRef) —

A valid CFHostRef object that can be resolved, or NULL if the host could not be created. Ownership follows the Create Rule.

- (`CFHostRef`) CFHostCreateWithAddress(allocator, addr)

Uses an address to create an instance of a host object.

Parameters:

allocator (CFAllocatorRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
addr (CFDataRef) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(CFHostRef) —

A valid CFHostRef object that can be resolved, or NULL if the host could not be created. Ownership follows the Create Rule.

- (`CFHostRef`) CFHostCreateWithName(allocator, hostname)

Uses a name to create an instance of a host object.

Parameters:

allocator (CFAllocatorRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
hostname (CFStringRef) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(CFHostRef) —

An array containing the of names of theHost, or NULL if no names were available.

- (`CFArrayRef`) CFHostGetAddressing(theHost, hasBeenResolved)

Gets the addresses from a host.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
hasBeenResolved (Boolean) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(CFArrayRef) —

A CFData object that wraps the reachability flags (SCNetworkConnectionFlags) defined in SystemConfiguration/SCNetwork.h, or NULL if reachability information was not available.

- (`CFArrayRef`) CFHostGetNames(theHost, hasBeenResolved)

Gets the names from a CFHost.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
hasBeenResolved (Boolean) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(CFArrayRef) —

The Core Foundation type identifier for the CFHost opaque type.

- (`CFDataRef`) CFHostGetReachability(theHost, hasBeenResolved)

Gets reachability information from a host.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
hasBeenResolved (Boolean) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.

Returns:

(CFDataRef) —

TRUE if the association could be set or unset, otherwise FALSE.

- (`nil`) CFHostScheduleWithRunLoop(theHost, runLoop, runLoopMode)

Schedules a CFHost on a run loop.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
runLoop (CFRunLoopRef) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.
runLoopMode (CFStringRef) —

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

Returns:

(nil)

- (`Boolean`) CFHostSetClient(theHost, clientCB, clientContext)

Associates a client context and a callback function with a CFHost object or disassociates a client context and callback function that were previously set.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
clientCB (CFHostClientCallBack) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.
clientContext (CFHostClientContext) —

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

Returns:

(Boolean)

- (`Boolean`) CFHostStartInfoResolution(theHost, info, error)

Starts resolution for a host object.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
info (CFHostInfoType) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.
error (CFStreamError) —

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

Returns:

(Boolean)

- (`nil`) CFHostUnscheduleFromRunLoop(theHost, runLoop, runLoopMode)

Unschedules a CFHost from a run loop.

Parameters:

theHost (CFHostRef) —

The host for which a resolution is to be cancelled. This value must not be NULL.
runLoop (CFRunLoopRef) —

A value of type CFHostInfoType specifying the type of resolution that is to be cancelled. See CFHostInfoType Constants for possible values.
runLoopMode (CFStringRef) —

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

Returns:

(nil)

- (`Boolean`) CFHTTPAuthenticationAppliesToRequest(auth, request)

Returns a Boolean value that indicates whether a CFHTTPAuthentication object is associated with a CFHTTPMessage object.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.
request (CFHTTPMessageRef) —

Request that auth is to be tested against.

Returns:

(Boolean) —

TRUE if auth is associated with request, otherwise FALSE.

- (`CFArrayRef`) CFHTTPAuthenticationCopyDomains(auth)

Returns an array of domain URLs to which a given CFHTTPAuthentication object can be applied.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.

Returns:

(CFArrayRef) —

A CFArray object that contains the domain URL’s to which auth should be applied. Ownership follows the Create Rule.

- (`CFStringRef`) CFHTTPAuthenticationCopyMethod(auth)

Gets the strongest authentication method that will be used when a CFHTTPAuthentication object is applied to a request.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.

Returns:

(CFStringRef) —

A string containing the authentication method that will be used auth is applied to a request. If more than one authentication method is available, the strongest authentication method is returned. Ownership follows the Create Rule.

- (`CFStringRef`) CFHTTPAuthenticationCopyRealm(auth)

Gets an authentication information’s namespace.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.

Returns:

(CFStringRef) —

The namespace, if there is one; otherwise NULL. Ownership follows the Create Rule.

- (`CFHTTPAuthenticationRef`) CFHTTPAuthenticationCreateFromResponse(alloc, response)

Uses an authentication failure response to create a CFHTTPAuthentication object.

Parameters:

alloc (CFAllocatorRef) —

The CFHTTPAuthentication object to examine.
response (CFHTTPMessageRef) —

Request that auth is to be tested against.

Returns:

(CFHTTPAuthenticationRef) —

CFHTTPAuthentication object that can be used for adding credentials to future requests. Ownership follows the Create Rule.

- (`Boolean`) CFHTTPAuthenticationIsValid(auth, error)

Returns a Boolean value that indicates whether a CFHTTPAuthentication object is valid.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.
error (CFStreamError) —

Request that auth is to be tested against.

Returns:

(Boolean) —

TRUE if auth contains enough information to be applied to a request.

- (`Boolean`) CFHTTPAuthenticationRequiresAccountDomain(auth)

Returns a Boolean value that indicates whether a CFHTTPAuthentication object uses an authentication method that requires an account domain.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.

Returns:

(Boolean) —

If this function returns FALSE, the CFHTTPAuthentication object may still contain useful information, such as the name of an unsupported authentication method.

- (`Boolean`) CFHTTPAuthenticationRequiresOrderedRequests(auth)

Returns a Boolean value that indicates whether authentication requests should be made one at a time.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.

Returns:

(Boolean) —

TRUE if auth uses an authentication method that requires an account domain, otherwise FALSE.

- (`Boolean`) CFHTTPAuthenticationRequiresUserNameAndPassword(auth)

Returns a Boolean value that indicates whether a CFHTTPAuthentication object uses an authentication method that requires a username and a password.

Parameters:

auth (CFHTTPAuthenticationRef) —

The CFHTTPAuthentication object to examine.

Returns:

(Boolean) —

TRUE if auth requires ordered requests, otherwise FALSE.

- (`Boolean`) CFHTTPMessageAddAuthentication(request, authenticationFailureResponse, username, password, authenticationScheme, forProxy)

Adds authentication information to a request.

Parameters:

request (CFHTTPMessageRef) —

The message to which to add authentication information.
authenticationFailureResponse (CFHTTPMessageRef) —

The response message that contains authentication failure information.
username (CFStringRef) —

The username to add to the request.
password (CFStringRef) —

The password to add to the request.
authenticationScheme (CFStringRef) —

The authentication scheme to use (kCFHTTPAuthenticationSchemeBasic, kCFHTTPAuthenticationSchemeNegotiate, kCFHTTPAuthenticationSchemeNTLM, or kCFHTTPAuthenticationSchemeDigest), or pass NULL to use the strongest supported authentication scheme provided in the authenticationFailureResponse parameter.
forProxy (Boolean) —

A flag indicating whether the authentication data that is being added is for a proxy’s use (TRUE) or for a remote server’s use (FALSE). If the error code provided by the authenticationFailureResponse parameter is 407, set forProxy to TRUE. If the error code is 401, set forProxy to FALSE.

Returns:

(Boolean) —

TRUE if the authentication information was successfully added, otherwise FALSE.

- (`Boolean`) CFHTTPMessageAppendBytes(message, newBytes, numBytes)

Appends data to a CFHTTPMessage object.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.
newBytes (const UInt8) —

The response message that contains authentication failure information.
numBytes (CFIndex) —

The username to add to the request.

Returns:

(Boolean) —

TRUE if the data was successfully appended, otherwise FALSE.

- (`Boolean`) CFHTTPMessageApplyCredentialDictionary(request, auth, dict, error)

Use a dictionary containing authentication credentials to perform the authentication method specified by a CFHTTPAuthentication object.

Parameters:

request (CFHTTPMessageRef) —

The message to which to add authentication information.
auth (CFHTTPAuthenticationRef) —

The response message that contains authentication failure information.
dict (CFDictionaryRef) —

The username to add to the request.
error (CFStreamError) —

The password to add to the request.

Returns:

(Boolean) —

TRUE if the authentication was successful, otherwise, FALSE.

- (`Boolean`) CFHTTPMessageApplyCredentials(request, auth, username, password, error)

Performs the authentication method specified by a CFHTTPAuthentication object.

Parameters:

request (CFHTTPMessageRef) —

The message to which to add authentication information.
auth (CFHTTPAuthenticationRef) —

The response message that contains authentication failure information.
username (CFStringRef) —

The username to add to the request.
password (CFStringRef) —

The password to add to the request.
error (CFStreamError) —

The authentication scheme to use (kCFHTTPAuthenticationSchemeBasic, kCFHTTPAuthenticationSchemeNegotiate, kCFHTTPAuthenticationSchemeNTLM, or kCFHTTPAuthenticationSchemeDigest), or pass NULL to use the strongest supported authentication scheme provided in the authenticationFailureResponse parameter.

Returns:

(Boolean) —

TRUE if the authentication was successful, otherwise, FALSE.

- (`CFDictionaryRef`) CFHTTPMessageCopyAllHeaderFields(message)

Gets all header fields from a CFHTTPMessage object.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFDictionaryRef) —

A CFDictionary object containing keys and values that are CFString objects, where the key is the header fieldname and the dictionary value is the header field’s value. Returns NULL if the header fields could not be copied. Ownership follows the Create Rule.

- (`CFDataRef`) CFHTTPMessageCopyBody(message)

Gets the body from a CFHTTPMessage object.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFDataRef) —

A CFData object or NULL if there was a problem creating the object or if the there is no message body. Ownership follows the Create Rule.

- (`CFStringRef`) CFHTTPMessageCopyHeaderFieldValue(message, headerField)

Gets the value of a header field from a CFHTTPMessage object.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.
headerField (CFStringRef) —

The response message that contains authentication failure information.

Returns:

(CFStringRef) —

A CFString object containing a copy of the field specified by headerField, or NULL if there was a problem creating the object of if the specified header does not exist. Ownership follows the Create Rule.

- (`CFStringRef`) CFHTTPMessageCopyRequestMethod(request)

Gets the request method from a CFHTTPMessage object.

Parameters:

request (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFStringRef) —

A CFString object containing a copy of the message’s request method, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFURLRef`) CFHTTPMessageCopyRequestURL(request)

Gets the URL from a CFHTTPMessage object.

Parameters:

request (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFURLRef) —

A CFURLRef object containing the URL or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFHTTPMessageCopyResponseStatusLine(response)

Gets the status line from a CFHTTPMessage object.

Parameters:

response (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFStringRef) —

A string containing the message’s status line, or NULL if there was a problem creating the object. The status line includes the message’s protocol version and a success or error code. Ownership follows the Create Rule.

- (`CFDataRef`) CFHTTPMessageCopySerializedMessage(request)

Serializes a CFHTTPMessage object.

Parameters:

request (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFDataRef) —

A CFData object containing the serialized message, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFHTTPMessageCopyVersion(message)

Gets the HTTP version from a CFHTTPMessage object.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFStringRef) —

A CFString object or NULL, if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFHTTPMessageRef`) CFHTTPMessageCreateCopy(alloc, message)

Gets a copy of a CFHTTPMessage object.

Parameters:

alloc (CFAllocatorRef) —

The message to which to add authentication information.
message (CFHTTPMessageRef) —

The response message that contains authentication failure information.

Returns:

(CFHTTPMessageRef) —

A CFHTTPMessage object, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFHTTPMessageRef`) CFHTTPMessageCreateEmpty(alloc, isRequest)

Creates and returns a new, empty CFHTTPMessage object.

Parameters:

alloc (CFAllocatorRef) —

The message to which to add authentication information.
isRequest (Boolean) —

The response message that contains authentication failure information.

Returns:

(CFHTTPMessageRef) —

A new CFHTTPMessage object or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFHTTPMessageRef`) CFHTTPMessageCreateRequest(alloc, requestMethod, url, httpVersion)

Creates and returns a CFHTTPMessage object for an HTTP request.

Parameters:

alloc (CFAllocatorRef) —

The message to which to add authentication information.
requestMethod (CFStringRef) —

The response message that contains authentication failure information.
url (CFURLRef) —

The username to add to the request.
httpVersion (CFStringRef) —

The password to add to the request.

Returns:

(CFHTTPMessageRef) —

A new CFHTTPMessage object, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFHTTPMessageRef`) CFHTTPMessageCreateResponse(alloc, statusCode, statusDescription, httpVersion)

Creates and returns a CFHTTPMessage object for an HTTP response.

Parameters:

alloc (CFAllocatorRef) —

The message to which to add authentication information.
statusCode (CFIndex) —

The response message that contains authentication failure information.
statusDescription (CFStringRef) —

The username to add to the request.
httpVersion (CFStringRef) —

The password to add to the request.

Returns:

(CFHTTPMessageRef) —

A new CFHTTPMessage object, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFIndex`) CFHTTPMessageGetResponseStatusCode(response)

Gets the status code from a CFHTTPMessage object representing an HTTP response.

Parameters:

response (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(CFIndex) —

The Core Foundation type identifier for the CFHTTPMessage opaque type.

- (`Boolean`) CFHTTPMessageIsHeaderComplete(message)

Determines whether a message header is complete.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(Boolean)

- (`extern`) CFHTTPMessageIsRequest(message)

Returns a boolean indicating whether the CFHTTPMessage is a request or a response.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.

Returns:

(extern)

- (`nil`) CFHTTPMessageSetBody(message, bodyData)

Sets the body of a CFHTTPMessage object.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.
bodyData (CFDataRef) —

The response message that contains authentication failure information.

Returns:

(nil)

- (`nil`) CFHTTPMessageSetHeaderFieldValue(message, headerField, value)

Sets the value of a header field in an HTTP message.

Parameters:

message (CFHTTPMessageRef) —

The message to which to add authentication information.
headerField (CFStringRef) —

The response message that contains authentication failure information.
value (CFStringRef) —

The username to add to the request.

Returns:

(nil)

- (`CFArrayRef`) CFLocaleCopyAvailableLocaleIdentifiers

Returns an array of CFString objects that represents all locales for which locale data is available.

Returns:

(CFArrayRef) —

An array of CFString objects that represents all locales for which locale data is available. Ownership follows the Create Rule.

- (`CFArrayRef`) CFLocaleCopyCommonISOCurrencyCodes

Returns an array of strings that represents ISO currency codes for currencies in common use.

Returns:

(CFArrayRef) —

An array of CFString objects that represents ISO currency codes for currencies in common use. Ownership follows the Create Rule.

- (`CFLocaleRef`) CFLocaleCopyCurrent

Returns a copy of the logical locale for the current user.

Returns:

(CFLocaleRef) —

The logical locale for the current user that is formed from the settings for the current user’s chosen system locale overlaid with any custom settings the user has specified in System Preferences. May return a retained cached object, not a new object. Ownership follows the Create Rule.

- (`CFStringRef`) CFLocaleCopyDisplayNameForPropertyValue(displayLocale, key, value)

Returns the display name for the given value.

Parameters:

displayLocale (CFLocaleRef) —

A locale object.
key (CFStringRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).
value (CFStringRef) —

The value for which the display name is required.

Returns:

(CFStringRef) —

The display name for value. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFArrayRef`) CFLocaleCopyISOCountryCodes

Returns an array of CFString objects that represents all known legal ISO country codes.

Returns:

(CFArrayRef) —

An array of CFString objects that represents all known legal ISO country codes. Ownership follows the Create Rule.

- (`CFArrayRef`) CFLocaleCopyISOCurrencyCodes

Returns an array of CFString objects that represents all known legal ISO currency codes.

Returns:

(CFArrayRef) —

An array of CFString objects that represents all known legal ISO currency codes.Ownership follows the Create Rule.

- (`CFArrayRef`) CFLocaleCopyISOLanguageCodes

Returns an array of CFString objects that represents all known legal ISO language codes.

Returns:

(CFArrayRef) —

An array of CFString objects that represents all known legal ISO language codes. Ownership follows the Create Rule.

- (`CFArrayRef`) CFLocaleCopyPreferredLanguages

Returns the array of canonicalized locale IDs that the user prefers.

Returns:

(CFArrayRef) —

The array of canonicalized CFString locale IDs that the current user prefers. Ownership follows the Create Rule.

- (`CFLocaleRef`) CFLocaleCreate(allocator, localeIdentifier)

Creates a locale for the given arbitrary locale identifier.

Parameters:

allocator (CFAllocatorRef) —

A locale object.
localeIdentifier (CFStringRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFLocaleRef) —

A new locale that corresponds to the arbitrary locale identifier localeIdentifier. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFLocaleCreateCanonicalLanguageIdentifierFromString(allocator, localeIdentifier)

Returns a canonical language identifier by mapping an arbitrary locale identification string to the canonical identifier

Parameters:

allocator (CFAllocatorRef) —

A locale object.
localeIdentifier (CFStringRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFStringRef) —

A string that represents the canonical language identifier for the specified arbitrary locale identifier. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFLocaleCreateCanonicalLocaleIdentifierFromScriptManagerCodes(allocator, lcode, rcode)

Returns a canonical locale identifier from given language and region codes.

Parameters:

allocator (CFAllocatorRef) —

A locale object.
lcode (LangCode) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).
rcode (RegionCode) —

The value for which the display name is required.

Returns:

(CFStringRef) —

A canonical locale identifier created by mapping lcode and rcode to a locale. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFLocaleCreateCanonicalLocaleIdentifierFromString(allocator, localeIdentifier)

Returns a canonical locale identifier by mapping an arbitrary locale identification string to the canonical identifier.

Parameters:

allocator (CFAllocatorRef) —

A locale object.
localeIdentifier (CFStringRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFStringRef) —

A canonical locale identifier created by mapping the arbitrary locale identification string to the canonical identifier for the corresponding locale (for example, “en”). Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFDictionaryRef`) CFLocaleCreateComponentsFromLocaleIdentifier(allocator, localeID)

Returns a dictionary containing the result from parsing a locale ID consisting of language, script, country, variant, and keyword/value pairs.

Parameters:

allocator (CFAllocatorRef) —

A locale object.
localeID (CFStringRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFDictionaryRef) —

A dictionary containing the result from parsing a locale ID consisting of language, script, country, variant, and keyword/value pairs. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFLocaleRef`) CFLocaleCreateCopy(allocator, locale)

Returns a copy of a locale.

Parameters:

allocator (CFAllocatorRef) —

A locale object.
locale (CFLocaleRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFLocaleRef) —

A new locale that is a copy of locale. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFStringRef`) CFLocaleCreateLocaleIdentifierFromComponents(allocator, dictionary)

Returns a locale identifier consisting of language, script, country, variant, and keyword/value pairs derived from a dictionary containing the source information.

Parameters:

allocator (CFAllocatorRef) —

A locale object.
dictionary (CFDictionaryRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFStringRef) —

A locale identifier consisting of language, script, country, variant, and keyword/value pairs derived from dictionary. Returns NULL if there was a problem creating the string. Ownership follows the Create Rule.

- (`CFStringRef`) CFLocaleCreateLocaleIdentifierFromWindowsLocaleCode(allocator, lcid)

Parameters:

allocator (CFAllocatorRef) —

A locale object.
lcid (Integer) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFStringRef)

- (`CFStringRef`) CFLocaleGetIdentifier(locale)

Returns the given locale's identifier.

Parameters:

locale (CFLocaleRef) —

A locale object.

Returns:

(CFStringRef) —

A string representation of locale’s identifier. This may not be the same string that was used to create the locale—it may be canonicalized. Ownership follows the Get Rule.

- (`CFLocaleLanguageDirection`) CFLocaleGetLanguageCharacterDirection(isoLangCode)

Parameters:

isoLangCode (CFStringRef) —

A locale object.

Returns:

(CFLocaleLanguageDirection)

- (`CFLocaleLanguageDirection`) CFLocaleGetLanguageLineDirection(isoLangCode)

Parameters:

isoLangCode (CFStringRef) —

A locale object.

Returns:

(CFLocaleLanguageDirection)

- (`CFLocaleRef`) CFLocaleGetSystem

Returns the root, canonical locale.

Returns:

(CFLocaleRef) —

The root, canonical locale. Ownership follows the Get Rule.

- (`CFTypeID`) CFLocaleGetTypeID

Returns the type identifier for the CFLocale opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFLocale opaque type.

- (`CFTypeRef`) CFLocaleGetValue(locale, key)

Returns the corresponding value for the given key of a locale’s key-value pair.

Parameters:

locale (CFLocaleRef) —

A locale object.
key (CFStringRef) —

A string that identifies the type that value is. It must be one of the standard locale property keys (see “Locale Property Keys”).

Returns:

(CFTypeRef) —

The value corresponding to the given key in locale. The value may be any type of CFType object. Ownership follows the Get Rule.

- (`Integer`) CFLocaleGetWindowsLocaleCodeFromLocaleIdentifier(localeIdentifier)

Parameters:

localeIdentifier (CFStringRef) —

A locale object.

Returns:

(Integer)

- (`CFMachPortRef`) CFMachPortCreate(allocator, callout, context, shouldFreeInfo)

Creates a CFMachPort object with a new Mach port.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
callout (CFMachPortCallBack) —

The callback function invoked when a message is received on the new Mach port.
context (CFMachPortContext) —

A structure holding contextual information for the new Mach port. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call.
shouldFreeInfo (Boolean) —

A flag set by the function to indicate whether the info member of context should be freed. The flag is set to true on failure, false otherwise. shouldFreeInfo can be NULL.

Returns:

(CFMachPortRef) —

The new CFMachPort object or NULL on failure. The CFMachPort object has both send and receive rights. Ownership follows the Create Rule.

- (`CFRunLoopSourceRef`) CFMachPortCreateRunLoopSource(allocator, port, order)

Creates a CFRunLoopSource object for a CFMachPort object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
port (CFMachPortRef) —

The callback function invoked when a message is received on the new Mach port.
order (CFIndex) —

A structure holding contextual information for the new Mach port. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call.

Returns:

(CFRunLoopSourceRef) —

The new CFRunLoopSource object for port. Ownership follows the Create Rule.

- (`CFMachPortRef`) CFMachPortCreateWithPort(allocator, portNum, callout, context, shouldFreeInfo)

Creates a CFMachPort object for a pre-existing native Mach port.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
portNum (mach_port_t) —

The callback function invoked when a message is received on the new Mach port.
callout (CFMachPortCallBack) —

A structure holding contextual information for the new Mach port. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call.
context (CFMachPortContext) —

A flag set by the function to indicate whether the info member of context should be freed. The flag is set to true on failure, false otherwise. shouldFreeInfo can be NULL.
shouldFreeInfo (Boolean) —

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

Returns:

(CFMachPortRef) —

The new CFMachPort object or NULL on failure. If a CFMachPort object already exists for portNum, the function returns the pre-existing object instead of creating a new object; the context and callout parameters are ignored in this case. Ownership follows the Create Rule.

- (`Object`) CFMachPortGetContext(port, context)

Returns the context information for a CFMachPort object.

Parameters:

port (CFMachPortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFMachPortContext) —

The callback function invoked when a message is received on the new Mach port.

Returns:

(Object) —

The callback function invoked when port is invalidated. NULL if no callback has been set with CFMachPortSetInvalidationCallBack.

- (`Object`) CFMachPortGetInvalidationCallBack(port)

Returns the invalidation callback function for a CFMachPort object.

Parameters:

port (CFMachPortRef) —

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

Returns:

(Object) —

The native Mach port represented by port.

- (`mach_port_t`) CFMachPortGetPort(port)

Returns the native Mach port represented by a CFMachPort object.

Parameters:

port (CFMachPortRef) —

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

Returns:

(mach_port_t) —

The type identifier for the CFMachPort opaque type.

- (`CFTypeID`) CFMachPortGetTypeID

Returns the type identifier for the CFMachPort opaque type.

Returns:

(CFTypeID) —

true if port can be used for communication, otherwise false.

- (`nil`) CFMachPortInvalidate(port)

Invalidates a CFMachPort object, stopping it from receiving any more messages.

Parameters:

port (CFMachPortRef) —

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

Returns:

(nil)

- (`Boolean`) CFMachPortIsValid(port)

Returns a Boolean value that indicates whether a CFMachPort object is valid and able to receive messages.

Parameters:

port (CFMachPortRef) —

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

Returns:

(Boolean)

- (`nil`) CFMachPortSetInvalidationCallBack(port, callout)

Sets the callback function invoked when a CFMachPort object is invalidated.

Parameters:

port (CFMachPortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
callout (Object) —

The callback function invoked when a message is received on the new Mach port.

Returns:

(nil)

- (`CFTypeRef`) CFMakeCollectable(cf)

Makes a newly-allocated Core Foundation object eligible for garbage collection.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFTypeRef) —

cf.

- (`CFMessagePortRef`) CFMessagePortCreateLocal(allocator, name, callout, context, shouldFreeInfo)

Returns a local CFMessagePort object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
name (CFStringRef) —

The name with which to register the port. name can be NULL.
callout (CFMessagePortCallBack) —

The callback function invoked when a message is received on the message port.
context (CFMessagePortContext) —

A structure holding contextual information for the message port. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call.
shouldFreeInfo (Boolean) —

A flag set by the function to indicate whether the info member of context should be freed. The flag is set to true on failure or if a local port named name already exists, false otherwise. shouldFreeInfo can be NULL.

Returns:

(CFMessagePortRef) —

The new CFMessagePort object, or NULL on failure. If a local port is already named name, the function returns that port instead of creating a new object; the context and callout parameters are ignored in this case. Ownership follows the Create Rule.

- (`CFMessagePortRef`) CFMessagePortCreateRemote(allocator, name)

Returns a CFMessagePort object connected to a remote port.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
name (CFStringRef) —

The name with which to register the port. name can be NULL.

Returns:

(CFMessagePortRef) —

The new CFMessagePort object, or NULL on failure. If a message port has already been created for the remote port, the pre-existing object is returned. Ownership follows the Create Rule.

- (`CFRunLoopSourceRef`) CFMessagePortCreateRunLoopSource(allocator, local, order)

Creates a CFRunLoopSource object for a CFMessagePort object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
local (CFMessagePortRef) —

The name with which to register the port. name can be NULL.
order (CFIndex) —

The callback function invoked when a message is received on the message port.

Returns:

(CFRunLoopSourceRef) —

The new CFRunLoopSource object for ms. Ownership follows the Create Rule.

- (`Object`) CFMessagePortGetContext(ms, context)

Returns the context information for a CFMessagePort object.

Parameters:

ms (CFMessagePortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFMessagePortContext) —

The name with which to register the port. name can be NULL.

Returns:

(Object) —

The callback function invoked when ms is invalidated. NULL if no callback has been set with CFMessagePortSetInvalidationCallBack.

- (`Object`) CFMessagePortGetInvalidationCallBack(ms)

Returns the invalidation callback function for a CFMessagePort object.

Parameters:

ms (CFMessagePortRef) —

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

Returns:

(Object) —

The registered name of ms, NULL if unnamed. Ownership follows the Get Rule.

- (`CFStringRef`) CFMessagePortGetName(ms)

Returns the name with which a CFMessagePort object is registered.

Parameters:

ms (CFMessagePortRef) —

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

Returns:

(CFStringRef) —

The type identifier for the CFMessagePort opaque type.

- (`CFTypeID`) CFMessagePortGetTypeID

Returns the type identifier for the CFMessagePort opaque type.

Returns:

(CFTypeID) —

true if ms is a remote port, otherwise false.

- (`Object`) CFMessagePortInvalidate(ms)

Invalidates a CFMessagePort object, stopping it from receiving or sending any more messages.

Parameters:

ms (CFMessagePortRef) —

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

Returns:

(Object) —

true if ms can be used for communication, otherwise false.

- (`Boolean`) CFMessagePortIsRemote(ms)

Returns a Boolean value that indicates whether a CFMessagePort object represents a remote port.

Parameters:

ms (CFMessagePortRef) —

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

Returns:

(Boolean) —

Error code indicating success or failure. See “CFMessagePortSendRequest Error Codes” for the possible return values.

- (`Boolean`) CFMessagePortIsValid(ms)

Returns a Boolean value that indicates whether a CFMessagePort object is valid and able to send or receive messages.

Parameters:

ms (CFMessagePortRef) —

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

Returns:

(Boolean) —

true if the name change succeeds, otherwise false.

- (`SInt32`) CFMessagePortSendRequest(remote, msgid, data, sendTimeout, rcvTimeout, replyMode, returnData)

Sends a message to a remote CFMessagePort object.

Parameters:

remote (CFMessagePortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
msgid (SInt32) —

The name with which to register the port. name can be NULL.
data (CFDataRef) —

The callback function invoked when a message is received on the message port.
sendTimeout (CFTimeInterval) —

A structure holding contextual information for the message port. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call.
rcvTimeout (CFTimeInterval) —

A flag set by the function to indicate whether the info member of context should be freed. The flag is set to true on failure or if a local port named name already exists, false otherwise. shouldFreeInfo can be NULL.
replyMode (CFStringRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
returnData (CFDataRef) —

The name of the remote message port to which to connect.

Returns:

(SInt32)

- (`nil`) CFMessagePortSetDispatchQueue(ms, queue)

Schedules callbacks for the specified message port on the specified dispatch queue.

Parameters:

ms (CFMessagePortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
queue (dispatch_queue_t) —

The name with which to register the port. name can be NULL.

Returns:

(nil)

- (`nil`) CFMessagePortSetInvalidationCallBack(ms, callout)

Sets the callback function invoked when a CFMessagePort object is invalidated.

Parameters:

ms (CFMessagePortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
callout (Object) —

The name with which to register the port. name can be NULL.

Returns:

(nil)

- (`Boolean`) CFMessagePortSetName(ms, newName)

Sets the name of a local CFMessagePort object.

Parameters:

ms (CFMessagePortRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
newName (CFStringRef) —

The name with which to register the port. name can be NULL.

Returns:

(Boolean)

- (`CFNetDiagnosticStatus`) CFNetDiagnosticCopyNetworkStatusPassively(details, description)

Gets a network status value.

Parameters:

details (CFNetDiagnosticRef) —

CFNetDiagnosticRef, created by CFNetDiagnosticCreateWithStreams or CFNetDiagnosticCreateWithURL, for which the Network Diagnostics status is to be obtained.
description (CFStringRef) —

If not NULL, upon return contains a localized string containing a description of the current network status. Ownership follows the Create Rule.

Returns:

(CFNetDiagnosticStatus) —

A network status value.

- (`CFNetDiagnosticRef`) CFNetDiagnosticCreateWithStreams(alloc, readStream, writeStream)

Creates a network diagnostic object from a pair of CFStreams.

Parameters:

alloc (CFAllocatorRef) —

CFNetDiagnosticRef, created by CFNetDiagnosticCreateWithStreams or CFNetDiagnosticCreateWithURL, for which the Network Diagnostics status is to be obtained.
readStream (CFReadStreamRef) —

If not NULL, upon return contains a localized string containing a description of the current network status. Ownership follows the Create Rule.
writeStream (CFWriteStreamRef) —

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

Returns:

(CFNetDiagnosticRef) —

CFNetDiagnosticRef that you can pass to CFNetDiagnosticDiagnoseProblemInteractively or CFNetDiagnosticCopyNetworkStatusPassively. Ownership follows the Create Rule.

- (`CFNetDiagnosticRef`) CFNetDiagnosticCreateWithURL(alloc, url)

Creates a CFNetDiagnosticRef from a CFURLRef.

Parameters:

alloc (CFAllocatorRef) —

CFNetDiagnosticRef, created by CFNetDiagnosticCreateWithStreams or CFNetDiagnosticCreateWithURL, for which the Network Diagnostics status is to be obtained.
url (CFURLRef) —

If not NULL, upon return contains a localized string containing a description of the current network status. Ownership follows the Create Rule.

Returns:

(CFNetDiagnosticRef) —

CFNetDiagnosticNoErr if no error occurred, or CFNetDiagnosticErr if an error occurred that prevented this call from completing successfully.

- (`CFNetDiagnosticStatus`) CFNetDiagnosticDiagnoseProblemInteractively(details)

Opens a Network Diagnostics window.

Parameters:

details (CFNetDiagnosticRef) —

CFNetDiagnosticRef, created by CFNetDiagnosticCreateWithStreams or CFNetDiagnosticCreateWithURL, for which the Network Diagnostics status is to be obtained.

Returns:

(CFNetDiagnosticStatus)

- (`nil`) CFNetDiagnosticSetName(details, name)

Overrides the displayed application name.

Parameters:

details (CFNetDiagnosticRef) —

CFNetDiagnosticRef, created by CFNetDiagnosticCreateWithStreams or CFNetDiagnosticCreateWithURL, for which the Network Diagnostics status is to be obtained.
name (CFStringRef) —

If not NULL, upon return contains a localized string containing a description of the current network status. Ownership follows the Create Rule.

Returns:

(nil)

- (`CFNetServiceBrowserRef`) CFNetServiceBrowserCreate(alloc, clientCB, clientContext)

Creates an instance of a Network Service browser object.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
clientCB (CFNetServiceBrowserClientCallBack) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
clientContext (CFNetServiceClientContext) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(CFNetServiceBrowserRef) —

A new browser object, or NULL if the instance could not be created. Ownership follows the Create Rule.

- (`Object`) CFNetServiceBrowserInvalidate(browser)

Invalidates an instance of a Network Service browser object.

Parameters:

browser (CFNetServiceBrowserRef) —

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

Returns:

(Object) —

TRUE if the search was started (asynchronous mode); FALSE if another search is already in progress for this CFNetServiceBrowser or if an error occurred.

- (`Object`) CFNetServiceBrowserScheduleWithRunLoop(browser, runLoop, runLoopMode)

Schedules a CFNetServiceBrowser on a run loop.

Parameters:

browser (CFNetServiceBrowserRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
runLoop (CFRunLoopRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
runLoopMode (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Object) —

TRUE if the search was started (asynchronous mode); FALSE if another search is already in progress for this CFNetServiceBrowser or if an error occurred.

- (`Boolean`) CFNetServiceBrowserSearchForDomains(browser, registrationDomains, error)

Searches for domains.

Parameters:

browser (CFNetServiceBrowserRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
registrationDomains (Boolean) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
error (CFStreamError) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Boolean) —

A new net service object, or NULL if the instance could not be created. Ownership follows the Create Rule.

- (`Boolean`) CFNetServiceBrowserSearchForServices(browser, domain, serviceType, error)

Searches a domain for services of a specified type.

Parameters:

browser (CFNetServiceBrowserRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
domain (CFStringRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
serviceType (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.
error (CFStreamError) —

The CFNetServiceBrowser to invalidate, obtained by a previous call to CFNetServiceBrowserCreate.

Returns:

(Boolean) —

Copy of service, including all previously resolved data, or NULL if service could not be copied. Ownership follows the Create Rule.

- (`Object`) CFNetServiceBrowserStopSearch(browser, error)

Stops a search for domains or services.

Parameters:

browser (CFNetServiceBrowserRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
error (CFStreamError) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.

Returns:

(Object) —

A dictionary containing the key/value pairs parsed from txtRecord, or NULL if txtRecord cannot be parsed. Each key in the dictionary is a CFString object, and each value is a CFData object. Ownership follows the Create Rule.

- (`Object`) CFNetServiceBrowserUnscheduleFromRunLoop(browser, runLoop, runLoopMode)

Unschedules a CFNetServiceBrowser from a run loop and mode.

Parameters:

browser (CFNetServiceBrowserRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
runLoop (CFRunLoopRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
runLoopMode (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Object) —

A CFData object containing the flattened form of keyValuePairs, or NULL if the dictionary could not be flattened. Ownership follows the Create Rule.

- (`Object`) CFNetServiceCancel(theService)

Cancels a service registration or a service resolution.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(Object) —

A CFArray containing a CFDataRef for each IP address returned, or NULL. Each CFDataRef consists of a sockaddr structure containing the IP address of the service. This function returns NULL if the service’s addressing is unknown because CFNetServiceResolve has not been called for theService.

- (`CFNetServiceRef`) CFNetServiceCreate(alloc, domain, serviceType, name, port)

Creates an instance of a Network Service object.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
domain (CFStringRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
serviceType (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.
name (CFStringRef) —

The CFNetServiceBrowser to invalidate, obtained by a previous call to CFNetServiceBrowserCreate.
port (SInt32) —

The CFNetServiceBrowser that is to be scheduled on a run loop; cannot be NULL.

Returns:

(CFNetServiceRef) —

A CFString object containing the domain of the CFNetService.

- (`CFNetServiceRef`) CFNetServiceCreateCopy(alloc, service)

Creates a copy of a CFNetService object.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
service (CFNetServiceRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.

Returns:

(CFNetServiceRef) —

A CFString object containing the name of the service represented by the CFNetService.

- (`CFDictionaryRef`) CFNetServiceCreateDictionaryWithTXTData(alloc, txtRecord)

Uses TXT record data to create a dictionary.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
txtRecord (CFDataRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.

Returns:

(CFDictionaryRef) —

A CFString object containing the protocol-specific information, or NULL if there is no information.

- (`CFDataRef`) CFNetServiceCreateTXTDataWithDictionary(alloc, keyValuePairs)

Flattens a set of key/value pairs into a CFDataRef suitable for passing to CFNetServiceSetTXTData.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
keyValuePairs (CFDictionaryRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.

Returns:

(CFDataRef) —

The target host name of the machine providing the service or NULL is of the service’s target host is not known. (The target host will not be known if it has not been resolved.)

- (`CFArrayRef`) CFNetServiceGetAddressing(theService)

Gets the IP addressing from a CFNetService.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(CFArrayRef) —

CFDataRef object containing the requested TXT data and suitable for passing to CFNetServiceCreateDictionaryWithTXTData, or NULL if the service’s TXT data has not been resolved.

- (`CFStringRef`) CFNetServiceGetDomain(theService)

Gets the domain from a CFNetService.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(CFStringRef) —

A CFString object containing the type from a CFNetService.

- (`CFStringRef`) CFNetServiceGetName(theService)

Gets the name from a CFNetService.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(CFStringRef) —

The type ID.

- (`extern`) CFNetServiceGetPortNumber(theService)

This function gets the port number from a CFNetService.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(extern) —

A new instance of a CFNetServiceMonitor, or NULL if the monitor could not be created. Ownership follows the Create Rule.

- (`CFStringRef`) CFNetServiceGetTargetHost(theService)

Queries a CFNetService for its target hosts.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(CFStringRef) —

The type ID.

- (`CFDataRef`) CFNetServiceGetTXTData(theService)

Queries a network service for the contents of its TXT records.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(CFDataRef) —

TRUE if an asynchronous monitor was started successfully. FALSE if an error occurred when starting an asynchronous or synchronous monitor, or if CFNetServiceMonitorStop was called for an synchronous monitor.

- (`CFStringRef`) CFNetServiceGetType(theService)

Gets the type from a CFNetService.

Parameters:

theService (CFNetServiceRef) —

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

Returns:

(CFStringRef) —

TRUE if an asynchronous service registration was started; FALSE if an asynchronous or synchronous registration failed or if a synchronous registration was canceled.

- (`CFNetServiceMonitorRef`) CFNetServiceMonitorCreate(alloc, theService, clientCB, clientContext)

Creates an instance of a NetServiceMonitor object that watches for record changes.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
theService (CFNetServiceRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
clientCB (CFNetServiceMonitorClientCallBack) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.
clientContext (CFNetServiceClientContext) —

The CFNetServiceBrowser to invalidate, obtained by a previous call to CFNetServiceBrowserCreate.

Returns:

(CFNetServiceMonitorRef) —

TRUE if the client was set; otherwise, FALSE.

- (`nil`) CFNetServiceMonitorInvalidate(monitor)

Invalidates an instance of a Network Service monitor object.

Parameters:

monitor (CFNetServiceMonitorRef) —

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

Returns:

(nil)

- (`nil`) CFNetServiceMonitorScheduleWithRunLoop(monitor, runLoop, runLoopMode)

Schedules a CFNetServiceMonitor on a run loop.

Parameters:

monitor (CFNetServiceMonitorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
runLoop (CFRunLoopRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
runLoopMode (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(nil)

- (`Boolean`) CFNetServiceMonitorStart(monitor, recordType, error)

Starts monitoring.

Parameters:

monitor (CFNetServiceMonitorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
recordType (CFNetServiceMonitorType) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
error (CFStreamError) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Boolean)

- (`nil`) CFNetServiceMonitorStop(monitor, error)

Stops a CFNetServiceMonitor.

Parameters:

monitor (CFNetServiceMonitorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
error (CFStreamError) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.

Returns:

(nil)

- (`nil`) CFNetServiceMonitorUnscheduleFromRunLoop(monitor, runLoop, runLoopMode)

Unschedules a CFNetServiceMonitor from a run loop.

Parameters:

monitor (CFNetServiceMonitorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
runLoop (CFRunLoopRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
runLoopMode (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(nil)

- (`Boolean`) CFNetServiceRegisterWithOptions(theService, options, error)

Makes a CFNetService available on the network.

Parameters:

theService (CFNetServiceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
options (CFOptionFlags) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
error (CFStreamError) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Boolean)

- (`Boolean`) CFNetServiceResolveWithTimeout(theService, timeout, error)

Gets the IP address or addresses for a CFNetService.

Parameters:

theService (CFNetServiceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
timeout (CFTimeInterval) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
error (CFStreamError) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Boolean)

- (`nil`) CFNetServiceScheduleWithRunLoop(theService, runLoop, runLoopMode)

Schedules a CFNetService on a run loop.

Parameters:

theService (CFNetServiceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
runLoop (CFRunLoopRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
runLoopMode (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(nil)

- (`Boolean`) CFNetServiceSetClient(theService, clientCB, clientContext)

Associates a callback function with a CFNetService or disassociates a callback function from a CFNetService.

Parameters:

theService (CFNetServiceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
clientCB (CFNetServiceClientCallBack) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
clientContext (CFNetServiceClientContext) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(Boolean)

- (`Boolean`) CFNetServiceSetTXTData(theService, txtRecord)

Sets the TXT record for a CFNetService.

Parameters:

theService (CFNetServiceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
txtRecord (CFDataRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.

Returns:

(Boolean)

- (`nil`) CFNetServiceUnscheduleFromRunLoop(theService, runLoop, runLoopMode)

Unschedules a CFNetService from a run loop.

Parameters:

theService (CFNetServiceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
runLoop (CFRunLoopRef) —

Callback function that is to be called when domains and services are found; cannot be NULL. For details, see CFNetServiceBrowserClientCallBack.
runLoopMode (CFStringRef) —

Context information to be used when clientCB is called; cannot be NULL. For details, see CFNetServiceClientContext.

Returns:

(nil)

- (`extern`) CFNetworkCopyProxiesForAutoConfigurationScript(proxyAutoConfigurationScript, targetURL)

Executes a proxy autoconfiguration script to determine the best proxy to use to retrieve a specified URL.

Parameters:

proxyAutoConfigurationScript (CFStringRef) —

A CFString containing the code of the autoconfiguration script to execute.
targetURL (CFURLRef) —

The URL your application intends to access.

Returns:

(extern) —

Returns an array of dictionaries. Each dictionary describes a single proxy. The array is ordered optimally for requesting the URL specified.

- (`extern`) CFNetworkCopyProxiesForURL(url, proxySettings)

Returns the list of proxies that should be used to download a given URL.

Parameters:

url (CFURLRef) —

A CFString containing the code of the autoconfiguration script to execute.
proxySettings (CFDictionaryRef) —

The URL your application intends to access.

Returns:

(extern)

- (`CFDictionaryRef`) CFNetworkCopySystemProxySettings

Returns a CFDictionary containing the current systemwide internet proxy settings.

Returns:

(CFDictionaryRef)

- (`CFRunLoopSourceRef`) CFNetworkExecuteProxyAutoConfigurationScript(proxyAutoConfigurationScript, targetURL, cb, clientContext)

Downloads a proxy autoconfiguration script and executes it.

Parameters:

proxyAutoConfigurationScript (CFStringRef) —

A CFString containing the code of the autoconfiguration script to execute.
targetURL (CFURLRef) —

The URL your application intends to access.
cb (CFProxyAutoConfigurationResultCallback) —

The URL your application intends to access.
clientContext (CFStreamClientContext) —

A dictionary describing the available proxy settings. The dictionary should be in the format returned by SystemConfiguration.framework. (See System Configuration Framework Reference for more information.)

Returns:

(CFRunLoopSourceRef)

- (`extern`) CFNetworkExecuteProxyAutoConfigurationURL(proxyAutoConfigURL, targetURL, cb, clientContext)

Downloads a proxy autoconfiguration script and executes it.

Parameters:

proxyAutoConfigURL (CFURLRef) —

A CFString containing the code of the autoconfiguration script to execute.
targetURL (CFURLRef) —

The URL your application intends to access.
cb (CFProxyAutoConfigurationResultCallback) —

The URL your application intends to access.
clientContext (CFStreamClientContext) —

A dictionary describing the available proxy settings. The dictionary should be in the format returned by SystemConfiguration.framework. (See System Configuration Framework Reference for more information.)

Returns:

(extern)

- (`Object`) CFNotificationCenterAddObserver(center, observer, callBack, name, object, suspensionBehavior)

Registers an observer to receive notifications.

Parameters:

center (CFNotificationCenterRef) —

The notification center to which to add the observer.
observer (Object) —

The observer. In OS X v10.3 and later, this parameter may be NULL.
callBack (CFNotificationCallback) —

The callback function to call when object posts the notification named name.
name (CFStringRef) —

The name of the notification to observe. If NULL, callback is called for any notification posted by object. If center is a Darwin notification center, this value must not be NULL.
object (Object) —

The object to observe. For distributed notifications, object must be a CFString object. If NULL, callback is called when a notification named name is posted by any object.If center is a Darwin notification center, this value is ignored.
suspensionBehavior (CFNotificationSuspensionBehavior) —

Flag indicating how notifications should be handled when the application is in the background. See “Notification Delivery Suspension Behavior” for the list of available values.If center is a Darwin notification center, this value is ignored.

Returns:

(Object) —

The application’s Darwin notification center.

- (`CFNotificationCenterRef`) CFNotificationCenterGetDarwinNotifyCenter

Returns the application’s Darwin notification center.

Returns:

(CFNotificationCenterRef) —

The application’s local notification center. An application has only one local notification center, so this function returns the same value each time it is called.

- (`CFNotificationCenterRef`) CFNotificationCenterGetLocalCenter

Returns the application’s local notification center.

Returns:

(CFNotificationCenterRef) —

The type identifier for the CFNotificationCenter opaque type.

- (`CFTypeID`) CFNotificationCenterGetTypeID

Returns the type identifier for the CFNotificationCenter opaque type.

Returns:

(CFTypeID)

- (`nil`) CFNotificationCenterPostNotification(center, name, object, userInfo, deliverImmediately)

Posts a notification for an object.

Parameters:

center (CFNotificationCenterRef) —

The notification center to which to add the observer.
name (CFStringRef) —

The observer. In OS X v10.3 and later, this parameter may be NULL.
object (Object) —

The callback function to call when object posts the notification named name.
userInfo (CFDictionaryRef) —

The name of the notification to observe. If NULL, callback is called for any notification posted by object. If center is a Darwin notification center, this value must not be NULL.
deliverImmediately (Boolean) —

The object to observe. For distributed notifications, object must be a CFString object. If NULL, callback is called when a notification named name is posted by any object.If center is a Darwin notification center, this value is ignored.

Returns:

(nil)

- (`nil`) CFNotificationCenterPostNotificationWithOptions(center, name, object, userInfo, options)

Posts a notification for an object using specified options.

Parameters:

center (CFNotificationCenterRef) —

The notification center to which to add the observer.
name (CFStringRef) —

The observer. In OS X v10.3 and later, this parameter may be NULL.
object (Object) —

The callback function to call when object posts the notification named name.
userInfo (CFDictionaryRef) —

The name of the notification to observe. If NULL, callback is called for any notification posted by object. If center is a Darwin notification center, this value must not be NULL.
options (CFOptionFlags) —

The object to observe. For distributed notifications, object must be a CFString object. If NULL, callback is called when a notification named name is posted by any object.If center is a Darwin notification center, this value is ignored.

Returns:

(nil)

- (`nil`) CFNotificationCenterRemoveEveryObserver(center, observer)

Stops an observer from receiving any notifications from any object.

Parameters:

center (CFNotificationCenterRef) —

The notification center to which to add the observer.
observer (Object) —

The observer. In OS X v10.3 and later, this parameter may be NULL.

Returns:

(nil)

- (`nil`) CFNotificationCenterRemoveObserver(center, observer, name, object)

Stops an observer from receiving certain notifications.

Parameters:

center (CFNotificationCenterRef) —

The notification center to which to add the observer.
observer (Object) —

The observer. In OS X v10.3 and later, this parameter may be NULL.
name (CFStringRef) —

The callback function to call when object posts the notification named name.
object (Object) —

The name of the notification to observe. If NULL, callback is called for any notification posted by object. If center is a Darwin notification center, this value must not be NULL.

Returns:

(nil)

- (`CFTypeID`) CFNullGetTypeID

Returns the type identifier for the CFNull opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFNull opaque type.

- (`CFComparisonResult`) CFNumberCompare(number, otherNumber, context)

Compares two CFNumber objects and returns a comparison result.

Parameters:

number (CFNumberRef) —

The first CFNumber object to compare.
otherNumber (CFNumberRef) —

The second CFNumber object to compare.
context (Object) —

Pass NULL.

Returns:

(CFComparisonResult) —

A CFComparisonResult constant that indicates whether number is equal to, less than, or greater than otherNumber.

- (`CFNumberRef`) CFNumberCreate(allocator, theType, valuePtr)

Creates a CFNumber object using a specified value.

Parameters:

allocator (CFAllocatorRef) —

The first CFNumber object to compare.
theType (CFNumberType) —

The second CFNumber object to compare.
valuePtr (Object) —

Pass NULL.

Returns:

(CFNumberRef) —

A new number with the value specified by valuePtr. Ownership follows the Create Rule.

- (`CFTypeRef`) CFNumberFormatterCopyProperty(formatter, key)

Returns a copy of a number formatter’s value for a given key.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.
key (CFStringRef) —

A property key. See “Number Formatter Property Keys” for valid values.

Returns:

(CFTypeRef) —

A CFType object that is a copy of the property value for key. Returns NULL if there is no value specified for key. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFNumberFormatterRef`) CFNumberFormatterCreate(allocator, locale, style)

Creates a new CFNumberFormatter object, localized to the given locale, which will format numbers to the given style.

Parameters:

allocator (CFAllocatorRef) —

The number formatter to examine.
locale (CFLocaleRef) —

A property key. See “Number Formatter Property Keys” for valid values.
style (CFNumberFormatterStyle) —

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

Returns:

(CFNumberFormatterRef) —

A new number formatter, localized to the given locale, which will format numbers using the given style. Returns NULL if there was a problem creating the formatter. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFNumberRef`) CFNumberFormatterCreateNumberFromString(allocator, formatter, string, rangep, options)

Returns a number object representing a given string.

Parameters:

allocator (CFAllocatorRef) —

The number formatter to examine.
formatter (CFNumberFormatterRef) —

A property key. See “Number Formatter Property Keys” for valid values.
string (CFStringRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
rangep (CFRange) —

A locale to use for localization. If NULL, the function uses the default system locale. Use CFLocaleCopyCurrent to specify the locale of the current user.
options (CFOptionFlags) —

A number style. See “Number Formatter Styles” for possible values.

Returns:

(CFNumberRef) —

A new number that represents the given string. Returns NULL if there was a problem creating the number. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFNumberFormatterCreateStringWithNumber(allocator, formatter, number)

Returns a string representation of the given number using the specified number formatter.

Parameters:

allocator (CFAllocatorRef) —

The number formatter to examine.
formatter (CFNumberFormatterRef) —

A property key. See “Number Formatter Property Keys” for valid values.
number (CFNumberRef) —

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

Returns:

(CFStringRef) —

A new string that represents the given number in the specified format. Returns NULL if there was a problem creating the string. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFNumberFormatterCreateStringWithValue(allocator, formatter, numberType, valuePtr)

Returns a string representation of the given number or value using the specified number formatter.

Parameters:

allocator (CFAllocatorRef) —

The number formatter to examine.
formatter (CFNumberFormatterRef) —

A property key. See “Number Formatter Property Keys” for valid values.
numberType (CFNumberType) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
valuePtr (Object) —

A locale to use for localization. If NULL, the function uses the default system locale. Use CFLocaleCopyCurrent to specify the locale of the current user.

Returns:

(CFStringRef) —

A new string that represents the given number or value formatted by formatter. Returns NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`Boolean`) CFNumberFormatterGetDecimalInfoForCurrencyCode(currencyCode, defaultFractionDigits, roundingIncrement)

Returns the number of fraction digits that should be displayed, and the rounding increment, for a given currency.

Parameters:

currencyCode (CFStringRef) —

The number formatter to examine.
defaultFractionDigits (Integer) —

A property key. See “Number Formatter Property Keys” for valid values.
roundingIncrement (Float) —

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

Returns:

(Boolean) —

true if the information was obtained successfully, otherwise false (for example, if the currency code is unknown or the information is not available).

- (`CFStringRef`) CFNumberFormatterGetFormat(formatter)

Returns a format string for the given number formatter object.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.

Returns:

(CFStringRef) —

The format string for formatter as was specified by calling the CFNumberFormatterSetFormat function, or derived from the number formatter’s style. The format of this string is defined by Unicode Technical Standard #35.. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFLocaleRef`) CFNumberFormatterGetLocale(formatter)

Returns the locale object used to create the given number formatter object.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.

Returns:

(CFLocaleRef) —

The locale used to create formatter. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFNumberFormatterStyle`) CFNumberFormatterGetStyle(formatter)

Returns the number style used to create the given number formatter object.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.

Returns:

(CFNumberFormatterStyle) —

The number style used to create formatter.

- (`CFTypeID`) CFNumberFormatterGetTypeID

Returns the type identifier for the CFNumberFormatter opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFNumberFormatter opaque type.

- (`Boolean`) CFNumberFormatterGetValueFromString(formatter, string, rangep, numberType, valuePtr)

Returns a number or value representing a given string.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.
string (CFStringRef) —

A property key. See “Number Formatter Property Keys” for valid values.
rangep (CFRange) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
numberType (CFNumberType) —

A locale to use for localization. If NULL, the function uses the default system locale. Use CFLocaleCopyCurrent to specify the locale of the current user.
valuePtr (Object) —

A number style. See “Number Formatter Styles” for possible values.

Returns:

(Boolean) —

true if the string was parsed successfully, otherwise false.

- (`nil`) CFNumberFormatterSetFormat(formatter, formatString)

Sets the format string of a number formatter.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.
formatString (CFStringRef) —

A property key. See “Number Formatter Property Keys” for valid values.

Returns:

(nil)

- (`nil`) CFNumberFormatterSetProperty(formatter, key, value)

Sets a number formatter property using a key-value pair.

Parameters:

formatter (CFNumberFormatterRef) —

The number formatter to examine.
key (CFStringRef) —

A property key. See “Number Formatter Property Keys” for valid values.
value (CFTypeRef) —

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

Returns:

(nil)

- (`CFIndex`) CFNumberGetByteSize(number)

Returns the number of bytes used by a CFNumber object to store its value.

Parameters:

number (CFNumberRef) —

The first CFNumber object to compare.

Returns:

(CFIndex) —

The size in bytes of the value contained in number.

- (`CFNumberType`) CFNumberGetType(number)

Returns the type used by a CFNumber object to store its value.

Parameters:

number (CFNumberRef) —

The first CFNumber object to compare.

Returns:

(CFNumberType) —

A constant that indicates the data type of the value contained in number. See Number Types for a list of possible values.

- (`CFTypeID`) CFNumberGetTypeID

Returns the type identifier for the CFNumber opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFNumber opaque type.

- (`Boolean`) CFNumberGetValue(number, theType, valuePtr)

Obtains the value of a CFNumber object cast to a specified type.

Parameters:

number (CFNumberRef) —

The first CFNumber object to compare.
theType (CFNumberType) —

The second CFNumber object to compare.
valuePtr (Object) —

Pass NULL.

Returns:

(Boolean) —

true if the operation was successful, otherwise false.

- (`Boolean`) CFNumberIsFloatType(number)

Determines whether a CFNumber object contains a value stored as one of the defined floating point types.

Parameters:

number (CFNumberRef) —

The first CFNumber object to compare.

Returns:

(Boolean) —

true if number's value is one of the defined floating point types, otherwise false. The valid floating point types are listed in Number Types.

- (`Object`) CFPlugInAddInstanceForFactory(factoryID)

Registers a new instance of a type with CFPlugIn.

Parameters:

factoryID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.

Returns:

(Object) —

A new plug-in. Ownership follows the Create Rule.

- (`CFPlugInRef`) CFPlugInCreate(allocator, plugInURL)

Creates a CFPlugIn given its URL.

Parameters:

allocator (CFAllocatorRef) —

The CFUUID object representing the plug-in factory.
plugInURL (CFURLRef) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.

Returns:

(CFPlugInRef) —

An array of UUIDs for factory functions capable of creating an instance of the given type.

- (`CFArrayRef`) CFPlugInFindFactoriesForPlugInType(typeUUID)

Searches all registered plug-ins for factory functions capable of creating an instance of the given type.

Parameters:

typeUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.

Returns:

(CFArrayRef) —

An array of UUIDs for factory functions capable of creating an instance of the given type.

- (`CFArrayRef`) CFPlugInFindFactoriesForPlugInTypeInPlugIn(typeUUID, plugIn)

Searches the given plug-in for factory functions capable of creating an instance of the given type.

Parameters:

typeUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.
plugIn (CFPlugInRef) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.

Returns:

(CFArrayRef) —

The bundle for plugIn. Ownership follows the Get Rule.

- (`CFBundleRef`) CFPlugInGetBundle(plugIn)

Returns a plug-in's bundle.

Parameters:

plugIn (CFPlugInRef) —

The CFUUID object representing the plug-in factory.

Returns:

(CFBundleRef) —

The type identifier for the CFPlugIn opaque type.

- (`CFTypeID`) CFPlugInGetTypeID

Returns the type identifier for the CFPlugIn opaque type.

Returns:

(CFTypeID) —

Returns the IUnknown interface for the new plug-in.

- (`Object`) CFPlugInInstanceCreate(allocator, factoryUUID, typeUUID)

Creates a CFPlugIn instance of a given type using a given factory.

Parameters:

allocator (CFAllocatorRef) —

The CFUUID object representing the plug-in factory.
factoryUUID (CFUUIDRef) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.
typeUUID (CFUUIDRef) —

The location of the plug-in.

Returns:

(Object) —

true if the plug-in is loaded only when a client requests an instance of a supported type, otherwise false.

- (`CFPlugInInstanceRef`) CFPlugInInstanceCreateWithInstanceDataSize(allocator, instanceDataSize, deallocateInstanceFunction, factoryName, getInterfaceFunction)

Not recommended.

Parameters:

allocator (CFAllocatorRef)
instanceDataSize (CFIndex)
deallocateInstanceFunction (CFPlugInInstanceDeallocateInstanceDataFunction)
factoryName (CFStringRef)
getInterfaceFunction (CFPlugInInstanceGetInterfaceFunction)

Returns:

(CFPlugInInstanceRef)

- (`CFStringRef`) CFPlugInInstanceGetFactoryName(instance)

Not recommended.

Parameters:

instance (CFPlugInInstanceRef)

Returns:

(CFStringRef)

- (`nil`) CFPlugInInstanceGetInstanceData(instance)

Not recommended.

Parameters:

instance (CFPlugInInstanceRef)

Returns:

(nil)

- (`Boolean`) CFPlugInInstanceGetInterfaceFunctionTable(instance, interfaceName, ftbl)

Not recommended.

Parameters:

instance (CFPlugInInstanceRef)
interfaceName (CFStringRef)
ftbl (Pointer)

Returns:

(Boolean)

- (`CFTypeID`) CFPlugInInstanceGetTypeID

Not recommended.

Returns:

(CFTypeID)

- (`Boolean`) CFPlugInIsLoadOnDemand(plugIn)

Determines whether or not a plug-in is loaded on demand.

Parameters:

plugIn (CFPlugInRef) —

The CFUUID object representing the plug-in factory.

Returns:

(Boolean) —

true if the factory function was successfully registered, otherwise false.

- (`Boolean`) CFPlugInRegisterFactoryFunction(factoryUUID, func)

Registers a factory function and its UUID with a CFPlugIn object.

Parameters:

factoryUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.
func (CFPlugInFactoryFunction) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.

Returns:

(Boolean) —

true if the factory function was successfully registered, otherwise false.

- (`Boolean`) CFPlugInRegisterFactoryFunctionByName(factoryUUID, plugIn, functionName)

Registers a factory function with a CFPlugIn object using the function's name instead of its UUID.

Parameters:

factoryUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.
plugIn (CFPlugInRef) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.
functionName (CFStringRef) —

The location of the plug-in.

Returns:

(Boolean) —

true if the factory function was successfully registered, otherwise false.

- (`Boolean`) CFPlugInRegisterPlugInType(factoryUUID, typeUUID)

Registers a type and its corresponding factory function with a CFPlugIn object.

Parameters:

factoryUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.
typeUUID (CFUUIDRef) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.

Returns:

(Boolean) —

true if the factory function was successfully unregistered, otherwise false.

- (`Object`) CFPlugInRemoveInstanceForFactory(factoryID)

Unregisters an instance of a type with CFPlugIn.

Parameters:

factoryID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.

Returns:

(Object) —

true if the factory function was successfully unregistered, otherwise false.

- (`nil`) CFPlugInSetLoadOnDemand(plugIn, flag)

Enables or disables load on demand for plug-ins that do dynamic registration (only when a client requests an instance of a supported type).

Parameters:

plugIn (CFPlugInRef) —

The CFUUID object representing the plug-in factory.
flag (Boolean) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.

Returns:

(nil)

- (`Boolean`) CFPlugInUnregisterFactory(factoryUUID)

Removes the given function from a plug-in’s list of registered factory functions.

Parameters:

factoryUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.

Returns:

(Boolean)

- (`Boolean`) CFPlugInUnregisterPlugInType(factoryUUID, typeUUID)

Removes the given type from a plug-in’s list of registered types.

Parameters:

factoryUUID (CFUUIDRef) —

The CFUUID object representing the plug-in factory.
typeUUID (CFUUIDRef) —

The allocator to use to allocate memory for the new plug-in. Pass NULL or kCFAllocatorDefault to use the default allocator.

Returns:

(Boolean)

- (`Object`) CFPreferencesAddSuitePreferencesToApp(applicationID, suiteID)

Adds suite preferences to an application’s preference search chain.

Parameters:

applicationID (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
suiteID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.

Returns:

(Object) —

true if synchronization was successful, otherwise false.

- (`Boolean`) CFPreferencesAppSynchronize(applicationID)

Writes to permanent storage all pending changes to the preference data for the application, and reads the latest preference data from permanent storage.

Parameters:

applicationID (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(Boolean) —

true if value of the key cannot be changed by the user, otherwise false.

- (`Boolean`) CFPreferencesAppValueIsForced(key, applicationID)

Determines whether or not a given key has been imposed on the user.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.

Returns:

(Boolean) —

The list of application IDs. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFPreferencesCopyApplicationList(userName, hostName)

Constructs and returns the list of all applications that have preferences in the scope of the specified user and host.

Parameters:

userName (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
hostName (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.

Returns:

(CFArrayRef) —

The preference data for the specified key and application. If no value was located, returns NULL. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFPropertyListRef`) CFPreferencesCopyAppValue(key, applicationID)

Obtains a preference value for the specified key and application.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.

Returns:

(CFPropertyListRef) —

The list of keys. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFPreferencesCopyKeyList(applicationID, userName, hostName)

Constructs and returns the list of all keys set in the specified domain.

Parameters:

applicationID (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
userName (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
hostName (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(CFArrayRef) —

A dictionary containing the preference values for the keys specified by keysToFetch for the specified domain. If no values were located, returns an empty dictionary. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFDictionaryRef`) CFPreferencesCopyMultiple(keysToFetch, applicationID, userName, hostName)

Returns a dictionary containing preference values for multiple keys.

Parameters:

keysToFetch (CFArrayRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
userName (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
hostName (CFStringRef) —

The key you are querying.

Returns:

(CFDictionaryRef) —

The preference data for the specified domain. If the no value was located, returns NULL. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFPropertyListRef`) CFPreferencesCopyValue(key, applicationID, userName, hostName)

Returns a preference value for a given domain.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
userName (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
hostName (CFStringRef) —

The key you are querying.

Returns:

(CFPropertyListRef) —

The preference data for the specified key and application, or if no value was located, false.

- (`Boolean`) CFPreferencesGetAppBooleanValue(key, applicationID, keyExistsAndHasValidFormat)

Convenience function that directly obtains a boolean preference value for the specified key.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
keyExistsAndHasValidFormat (Boolean) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(Boolean) —

The preference data for the specified key and application. If no value was located, 0 is returned.

- (`CFIndex`) CFPreferencesGetAppIntegerValue(key, applicationID, keyExistsAndHasValidFormat)

Convenience function that directly obtains an integer preference value for the specified key.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
keyExistsAndHasValidFormat (Boolean) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(CFIndex) —

true if synchronization was successful, false if an error occurred.

- (`nil`) CFPreferencesRemoveSuitePreferencesFromApp(applicationID, suiteID)

Removes suite preferences from an application’s search chain.

Parameters:

applicationID (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
suiteID (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.

Returns:

(nil)

- (`nil`) CFPreferencesSetAppValue(key, value, applicationID)

Adds, modifies, or removes a preference.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
value (CFPropertyListRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(nil)

- (`nil`) CFPreferencesSetMultiple(keysToSet, keysToRemove, applicationID, userName, hostName)

Convenience function that allows you to set and remove multiple preference values.

Parameters:

keysToSet (CFDictionaryRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
keysToRemove (CFArrayRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
userName (CFStringRef) —

The key you are querying.
hostName (CFStringRef) —

The application’s ID, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(nil)

- (`nil`) CFPreferencesSetValue(key, value, applicationID, userName, hostName)

Adds, modifies, or removes a preference value for the specified domain.

Parameters:

key (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
value (CFPropertyListRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
applicationID (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
userName (CFStringRef) —

The key you are querying.
hostName (CFStringRef) —

The application’s ID, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(nil)

- (`Boolean`) CFPreferencesSynchronize(applicationID, userName, hostName)

For the specified domain, writes all pending changes to preference data to permanent storage, and reads latest preference data from permanent storage.

Parameters:

applicationID (CFStringRef) —

The ID of the application to which to add suite preferences, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.
userName (CFStringRef) —

The ID of the application suite preferences to add. Takes the form of a Java package name, com.foosoft.
hostName (CFStringRef) —

The ID of the application whose preferences to write to storage, typically kCFPreferencesCurrentApplication. Do not pass NULL or kCFPreferencesAnyApplication. Takes the form of a Java package name, com.foosoft.

Returns:

(Boolean)

- (`CFDataRef`) CFPropertyListCreateData(allocator, propertyList, format, options, error)

Returns a CFData object containing a serialized representation of a given property list in a specified format.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
propertyList (CFPropertyListRef) —

The property list to write out.
format (CFPropertyListFormat) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
options (CFOptionFlags) —

This parameter is currently unused and should be set to 0.
error (CFErrorRef) —

If this parameter is non-NULL, if an error occurs, on return this will contain a CFError error describing the problem. Ownership follows the Create Rule.

Returns:

(CFDataRef) —

A CFData object containing a serialized representation of propertyList in a the format specified by format. Ownership follows the Create Rule.

- (`CFPropertyListRef`) CFPropertyListCreateDeepCopy(allocator, propertyList, mutabilityOption)

Recursively creates a copy of a given property list.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
propertyList (CFPropertyListRef) —

The property list to write out.
mutabilityOption (CFOptionFlags) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.

Returns:

(CFPropertyListRef) —

A new property list that is a copy of propertyList. Ownership follows the Create Rule.

- (`CFPropertyListRef`) CFPropertyListCreateFromStream(allocator, stream, streamLength, mutabilityOption, format, errorString)

Creates a property list using data from a stream.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
stream (CFReadStreamRef) —

The property list to write out.
streamLength (CFIndex) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
mutabilityOption (CFOptionFlags) —

This parameter is currently unused and should be set to 0.
format (CFPropertyListFormat) —

If this parameter is non-NULL, if an error occurs, on return this will contain a CFError error describing the problem. Ownership follows the Create Rule.
errorString (CFStringRef) —

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

Returns:

(CFPropertyListRef) —

A new property list initialized with the data contained in stream. Ownership follows the Create Rule.

- (`CFPropertyListRef`) CFPropertyListCreateFromXMLData(allocator, xmlData, mutabilityOption, errorString)

Creates a property list using the specified XML or binary property list data.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
xmlData (CFDataRef) —

The property list to write out.
mutabilityOption (CFOptionFlags) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
errorString (CFStringRef) —

This parameter is currently unused and should be set to 0.

Returns:

(CFPropertyListRef) —

A new property list if the conversion is successful, otherwise NULL. Ownership follows the Create Rule.

- (`CFPropertyListRef`) CFPropertyListCreateWithData(allocator, data, options, format, error)

Creates a property list from a given CFData object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
data (CFDataRef) —

The property list to write out.
options (CFOptionFlags) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
format (CFPropertyListFormat) —

This parameter is currently unused and should be set to 0.
error (CFErrorRef) —

If this parameter is non-NULL, if an error occurs, on return this will contain a CFError error describing the problem. Ownership follows the Create Rule.

Returns:

(CFPropertyListRef) —

A new property list created from the data in data. If an error occurs while parsing the data, returns NULL. Ownership follows the Create Rule.

- (`CFPropertyListRef`) CFPropertyListCreateWithStream(allocator, stream, streamLength, options, format, error)

Create and return a property list with a CFReadStream input.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
stream (CFReadStreamRef) —

The property list to write out.
streamLength (CFIndex) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
options (CFOptionFlags) —

This parameter is currently unused and should be set to 0.
format (CFPropertyListFormat) —

If this parameter is non-NULL, if an error occurs, on return this will contain a CFError error describing the problem. Ownership follows the Create Rule.
error (CFErrorRef) —

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

Returns:

(CFPropertyListRef) —

A new property list created from the data in stream. If an error occurs while parsing the data, returns NULL. Ownership follows the Create Rule.

- (`CFDataRef`) CFPropertyListCreateXMLData(allocator, propertyList)

Creates an XML representation of the specified property list.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
propertyList (CFPropertyListRef) —

The property list to write out.

Returns:

(CFDataRef) —

A CFData object containing the XML data. Ownership follows the Create Rule.

- (`Boolean`) CFPropertyListIsValid(plist, format)

Determines if a property list is valid.

Parameters:

plist (CFPropertyListRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
format (CFPropertyListFormat) —

The property list to write out.

Returns:

(Boolean) —

true if the object graph rooted at plist is a valid property list graph—that is, the property list contains no cycles, only contains property list objects, and all dictionary keys are strings; otherwise false.

- (`CFIndex`) CFPropertyListWrite(propertyList, stream, format, options, error)

Write the bytes of a serialized property list out to a stream.

Parameters:

propertyList (CFPropertyListRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
stream (CFWriteStreamRef) —

The property list to write out.
format (CFPropertyListFormat) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
options (CFOptionFlags) —

This parameter is currently unused and should be set to 0.
error (CFErrorRef) —

If this parameter is non-NULL, if an error occurs, on return this will contain a CFError error describing the problem. Ownership follows the Create Rule.

Returns:

(CFIndex) —

The number of bytes written to stream. If an error occurs, returns 0.

- (`CFIndex`) CFPropertyListWriteToStream(propertyList, stream, format, errorString)

Writes the bytes of a property list serialization out to a stream.

Parameters:

propertyList (CFPropertyListRef) —

The allocator to use to allocate memory for the new data object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
stream (CFWriteStreamRef) —

The property list to write out.
format (CFPropertyListFormat) —

A CFPropertyListFormat constant to specify the data format. See “Property List Formats” for possible values.
errorString (CFStringRef) —

This parameter is currently unused and should be set to 0.

Returns:

(CFIndex) —

The number of bytes written, or 0 if an error occurred. If 0 is returned, errorString will contain an error message.

- (`Object`) CFReadStreamClose(stream)

Closes a readable stream.

Parameters:

stream (CFReadStreamRef) —

The stream to close.

Returns:

(Object) —

A CFError object that describes the current problem with stream, or NULL if there is no error. Ownership follows the Create Rule.

- (`CFErrorRef`) CFReadStreamCopyError(stream)

Returns the error associated with a stream.

Parameters:

stream (CFReadStreamRef) —

The stream to close.

Returns:

(CFErrorRef) —

The value of the property propertyName. Ownership follows the Create Rule.

- (`CFTypeRef`) CFReadStreamCopyProperty(stream, propertyName)

Returns the value of a property for a stream.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
propertyName (CFStringRef) —

The stream to examine.

Returns:

(CFTypeRef) —

The new read stream, or NULL on failure. Ownership follows the Create Rule.

- (`CFReadStreamRef`) CFReadStreamCreateForHTTPRequest(alloc, request)

Creates a read stream for a CFHTTP request message.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
request (CFHTTPMessageRef) —

A CFHTTP request message whose body and headers have been set.

Returns:

(CFReadStreamRef) —

A new read stream, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFReadStreamRef`) CFReadStreamCreateForStreamedHTTPRequest(alloc, requestHeaders, requestBody)

Creates a read stream for a CFHTTP request message object whose body is too long to keep in memory.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
requestHeaders (CFHTTPMessageRef) —

A CFHTTP request message whose body and headers have been set.
requestBody (CFReadStreamRef) —

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

Returns:

(CFReadStreamRef) —

A new read stream, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFReadStreamRef`) CFReadStreamCreateWithBytesNoCopy(alloc, bytes, length, bytesDeallocator)

Creates a readable stream for a block of memory.

Parameters:

alloc (CFAllocatorRef) —

The stream to close.
bytes (const UInt8) —

The stream to examine.
length (CFIndex) —

The stream to examine.
bytesDeallocator (CFAllocatorRef) —

The name of the stream property to obtain. The available properties for standard Core Foundation streams are listed in CFStream Reference.

Returns:

(CFReadStreamRef) —

The new readable stream object, or NULL on failure. Ownership follows the Create Rule.

- (`CFReadStreamRef`) CFReadStreamCreateWithFile(alloc, fileURL)

Creates a readable stream for a file.

Parameters:

alloc (CFAllocatorRef) —

The stream to close.
fileURL (CFURLRef) —

The stream to examine.

Returns:

(CFReadStreamRef) —

A pointer to the internal buffer of unread data for stream, if possible; NULL otherwise. The buffer is good only until the next stream operation called on the stream. You should neither change the contents of the returned buffer nor attempt to deallocate the buffer; it is still owned by the stream. The bytes returned in the buffer are considered read from the stream.

- (`CFReadStreamRef`) CFReadStreamCreateWithFTPURL(alloc, ftpURL)

Creates an FTP read stream.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the dictionary. Pass NULL or kCFAllocatorDefault to use the current default allocator.
ftpURL (CFURLRef) —

A pointer to a buffer holding zero or more lines of resource listing.

Returns:

(CFReadStreamRef) —

A new read stream, or NULL if the call failed. Ownership follows the Create Rule.

- (`const`) CFReadStreamGetBuffer(stream, maxBytesToRead, numBytesRead)

Returns a pointer to a stream’s internal buffer of unread data, if possible.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
maxBytesToRead (CFIndex) —

The stream to examine.
numBytesRead (CFIndex) —

The stream to examine.

Returns:

(const) —

The error status of stream returned in a CFStreamError structure.

- (`CFStreamError`) CFReadStreamGetError(stream)

Returns the error status of a stream. (Deprecated. Use CFReadStreamCopyError instead.)

Parameters:

stream (CFReadStreamRef) —

The stream to close.

Returns:

(CFStreamError) —

The error field is 0 if no error has occurred. If the error field is not 0, the domain field contains a code that identifies the domain in which the value of the error field should be interpreted.

- (`CFStreamStatus`) CFReadStreamGetStatus(stream)

Returns the current state of a stream.

Parameters:

stream (CFReadStreamRef) —

The stream to close.

Returns:

(CFStreamStatus) —

The current state of stream. See CFStreamStatus for the list of possible states.

- (`CFTypeID`) CFReadStreamGetTypeID

Returns the type identifier the CFReadStream opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFReadStream opaque type.

- (`Boolean`) CFReadStreamHasBytesAvailable(stream)

Returns a Boolean value that indicates whether a readable stream has data that can be read without blocking.

Parameters:

stream (CFReadStreamRef) —

The stream to close.

Returns:

(Boolean) —

TRUE if data can be read from stream without blocking, otherwise FALSE. If stream cannot tell if data is available without actually trying to read the data, this function returns TRUE.

- (`Boolean`) CFReadStreamOpen(stream)

Opens a stream for reading.

Parameters:

stream (CFReadStreamRef) —

The stream to close.

Returns:

(Boolean) —

TRUE if stream was successfully opened, FALSE otherwise. If stream is not in the kCFStreamStatusNotOpen state, this function returns FALSE.

- (`CFIndex`) CFReadStreamRead(stream, buffer, bufferLength)

Reads data from a readable stream.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
buffer (UInt8) —

The stream to examine.
bufferLength (CFIndex) —

The stream to examine.

Returns:

(CFIndex) —

The number of bytes read; 0 if the stream has reached its end; or -1 if either the stream is not open or an error occurs.

- (`Object`) CFReadStreamScheduleWithRunLoop(stream, runLoop, runLoopMode)

Schedules a stream into a run loop.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
runLoop (CFRunLoopRef) —

The stream to examine.
runLoopMode (CFStringRef) —

The stream to examine.

Returns:

(Object) —

TRUE if the stream supports asynchronous notification, otherwise FALSE.

- (`Boolean`) CFReadStreamSetClient(stream, streamEvents, clientCB, clientContext)

Assigns a client to a stream, which receives callbacks when certain events occur.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
streamEvents (CFOptionFlags) —

The stream to examine.
clientCB (CFReadStreamClientCallBack) —

The stream to examine.
clientContext (CFStreamClientContext) —

The name of the stream property to obtain. The available properties for standard Core Foundation streams are listed in CFStream Reference.

Returns:

(Boolean) —

TRUE if stream recognizes and accepts the given property-value pair, otherwiseFALSE.

- (`Boolean`) CFReadStreamSetProperty(stream, propertyName, propertyValue)

Sets the value of a property for a stream.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
propertyName (CFStringRef) —

The stream to examine.
propertyValue (CFTypeRef) —

The stream to examine.

Returns:

(Boolean)

- (`nil`) CFReadStreamUnscheduleFromRunLoop(stream, runLoop, runLoopMode)

Removes a read stream from a given run loop.

Parameters:

stream (CFReadStreamRef) —

The stream to close.
runLoop (CFRunLoopRef) —

The stream to examine.
runLoopMode (CFStringRef) —

The stream to examine.

Returns:

(nil)

- (`Object`) CFRelease(cf)

Releases a Core Foundation object.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(Object) —

The input value, cf.

- (`CFTypeRef`) CFRetain(cf)

Retains a Core Foundation object.

Parameters:

cf (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(CFTypeRef)

- (`Object`) CFRunLoopAddCommonMode(rl, mode)

Adds a mode to the set of run loop common modes.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
mode (CFStringRef) —

The run loop mode to add to the set of common modes of rl.

Returns:

(Object) —

true if observer is in mode mode of the run loop rl, otherwise false.

- (`Object`) CFRunLoopAddObserver(rl, observer, mode)

Adds a CFRunLoopObserver object to a run loop mode.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
observer (CFRunLoopObserverRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(Object) —

true if source is in mode mode of the run loop rl, otherwise false.

- (`Object`) CFRunLoopAddSource(rl, source, mode)

Adds a CFRunLoopSource object to a run loop mode.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
source (CFRunLoopSourceRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(Object) —

true if timer is in mode mode of the run loop rl, false otherwise.

- (`Object`) CFRunLoopAddTimer(rl, timer, mode)

Adds a CFRunLoopTimer object to a run loop mode.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
timer (CFRunLoopTimerRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(Object) —

An array that contains all the run loop modes defined for rl. Ownership follows the Create Rule.

- (`Boolean`) CFRunLoopContainsObserver(rl, observer, mode)

Returns a Boolean value that indicates whether a run loop mode contains a particular CFRunLoopObserver object.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
observer (CFRunLoopObserverRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(Boolean) —

The mode in which rl is currently running; NULL if rl is not running. Ownership follows the Create Rule.

- (`Boolean`) CFRunLoopContainsSource(rl, source, mode)

Returns a Boolean value that indicates whether a run loop mode contains a particular CFRunLoopSource object.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
source (CFRunLoopSourceRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(Boolean) —

Current thread’s run loop. Ownership follows the Get Rule.

- (`Boolean`) CFRunLoopContainsTimer(rl, timer, mode)

Returns a Boolean value that indicates whether a run loop mode contains a particular CFRunLoopTimer object.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
timer (CFRunLoopTimerRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(Boolean) —

The main run loop. Ownership follows the Get Rule.

- (`CFArrayRef`) CFRunLoopCopyAllModes(rl)

Returns an array that contains all the defined modes for a CFRunLoop object.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.

Returns:

(CFArrayRef) —

The earliest firing time of the run loop timers registered in mode for the run loop rl.

- (`CFStringRef`) CFRunLoopCopyCurrentMode(rl)

Returns the name of the mode in which a given run loop is currently running.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.

Returns:

(CFStringRef) —

The type identifier for the CFRunLoop opaque type.

- (`CFRunLoopRef`) CFRunLoopGetCurrent

Returns the CFRunLoop object for the current thread.

Returns:

(CFRunLoopRef) —

true if rl has no events to process and is blocking, waiting for a source or timer to become ready to fire; false if rl either is not running or is currently processing a source, timer, or observer.

- (`CFRunLoopRef`) CFRunLoopGetMain

Returns the main CFRunLoop object.

Returns:

(CFRunLoopRef) —

A value indicating the reason the run loop exited. Possible values are described below.

- (`CFAbsoluteTime`) CFRunLoopGetNextTimerFireDate(rl, mode)

Returns the time at which the next timer will fire.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
mode (CFStringRef) —

The run loop mode to add to the set of common modes of rl.

Returns:

(CFAbsoluteTime)

- (`CFTypeID`) CFRunLoopGetTypeID

Returns the type identifier for the CFRunLoop opaque type.

Returns:

(CFTypeID)

- (`Boolean`) CFRunLoopIsWaiting(rl)

Returns a Boolean value that indicates whether the run loop is waiting for an event.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.

Returns:

(Boolean)

- (`CFRunLoopObserverRef`) CFRunLoopObserverCreate(allocator, activities, repeats, order, callout, context)

Creates a CFRunLoopObserver object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
activities (CFOptionFlags) —

Set of flags identifying the activity stages of the run loop during which the observer should be called. See Run Loop Activitiesfor the list of stages. To have the observer called at multiple stages in the run loop, combine the Run Loop Activities values using the bitwise-OR operator.
repeats (Boolean) —

A flag identifying whether the observer should be called only once or every time through the run loop. If repeats is false, the observer is invalidated after it is called once, even if the observer was scheduled to be called at multiple stages within the run loop.
order (CFIndex) —

A priority index indicating the order in which run loop observers are processed. When multiple run loop observers are scheduled in the same activity stage in a given run loop mode, the observers are processed in increasing order of this parameter. Pass 0 unless there is a reason to do otherwise.
callout (CFRunLoopObserverCallBack) —

The callback function invoked when the observer runs.
context (CFRunLoopObserverContext) —

A structure holding contextual information for the run loop observer. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call. Can be NULL if the observer does not need the context’s info pointer to keep track of state.

Returns:

(CFRunLoopObserverRef) —

The new CFRunLoopObserver object. Ownership follows the Create Rule.

- (`Boolean`) CFRunLoopObserverDoesRepeat(observer)

Returns a Boolean value that indicates whether a CFRunLoopObserver repeats.

Parameters:

observer (CFRunLoopObserverRef) —

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

Returns:

(Boolean) —

true if observer is processed during every pass through the run loop; false if observer is processed once and then is invalidated.

- (`CFOptionFlags`) CFRunLoopObserverGetActivities(observer)

Returns the run loop stages during which an observer runs.

Parameters:

observer (CFRunLoopObserverRef) —

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

Returns:

(CFOptionFlags) —

A bitwise-OR combination of all the run loop stages in which observer is called. See Run Loop Activities for the list of stages.

- (`Object`) CFRunLoopObserverGetContext(observer, context)

Returns the context information for a CFRunLoopObserver object.

Parameters:

observer (CFRunLoopObserverRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFRunLoopObserverContext) —

Set of flags identifying the activity stages of the run loop during which the observer should be called. See Run Loop Activitiesfor the list of stages. To have the observer called at multiple stages in the run loop, combine the Run Loop Activities values using the bitwise-OR operator.

Returns:

(Object) —

The ordering parameter for observer. When multiple observers are scheduled in the same run loop mode and stage, this value determines the order (from small to large) in which the observers are called.

- (`CFIndex`) CFRunLoopObserverGetOrder(observer)

Returns the ordering parameter for a CFRunLoopObserver object.

Parameters:

observer (CFRunLoopObserverRef) —

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

Returns:

(CFIndex) —

The type identifier for the CFRunLoopObserver opaque type.

- (`CFTypeID`) CFRunLoopObserverGetTypeID

Returns the type identifier for the CFRunLoopObserver opaque type.

Returns:

(CFTypeID) —

true if observer is valid, otherwise false.

- (`nil`) CFRunLoopObserverInvalidate(observer)

Invalidates a CFRunLoopObserver object, stopping it from ever firing again.

Parameters:

observer (CFRunLoopObserverRef) —

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

Returns:

(nil)

- (`Boolean`) CFRunLoopObserverIsValid(observer)

Returns a Boolean value that indicates whether a CFRunLoopObserver object is valid and able to fire.

Parameters:

observer (CFRunLoopObserverRef) —

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

Returns:

(Boolean)

- (`nil`) CFRunLoopPerformBlock(rl, mode, ^block(void))

Enqueues a block object on a given runloop to be executed as the runloop cycles in specified modes.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
mode (CFTypeRef) —

The run loop mode to add to the set of common modes of rl.
(^block)(void) (Object) —

The run loop to modify.

Returns:

(nil)

- (`nil`) CFRunLoopRemoveObserver(rl, observer, mode)

Removes a CFRunLoopObserver object from a run loop mode.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
observer (CFRunLoopObserverRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(nil)

- (`nil`) CFRunLoopRemoveSource(rl, source, mode)

Removes a CFRunLoopSource object from a run loop mode.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
source (CFRunLoopSourceRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(nil)

- (`nil`) CFRunLoopRemoveTimer(rl, timer, mode)

Removes a CFRunLoopTimer object from a run loop mode.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
timer (CFRunLoopTimerRef) —

The run loop mode to add to the set of common modes of rl.
mode (CFStringRef) —

The run loop to modify.

Returns:

(nil)

- (`nil`) CFRunLoopRun

Runs the current thread’s CFRunLoop object in its default mode indefinitely.

Returns:

(nil)

- (`SInt32`) CFRunLoopRunInMode(mode, seconds, returnAfterSourceHandled)

Runs the current thread’s CFRunLoop object in a particular mode.

Parameters:

mode (CFStringRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.
seconds (CFTimeInterval) —

The run loop mode to add to the set of common modes of rl.
returnAfterSourceHandled (Boolean) —

The run loop to modify.

Returns:

(SInt32)

- (`CFRunLoopSourceRef`) CFRunLoopSourceCreate(allocator, order, context)

Creates a CFRunLoopSource object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
order (CFIndex) —

A priority index indicating the order in which run loop sources are processed. When multiple run loop sources are firing in a single pass through the run loop, the sources are processed in increasing order of this parameter. If the run loop is set to process only one source per loop, only the highest priority source, the one with the lowest order value, is processed. This value is ignored for version 1 sources. Pass 0 unless there is a reason to do otherwise.
context (CFRunLoopSourceContext) —

A structure holding contextual information for the run loop source. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call.

Returns:

(CFRunLoopSourceRef) —

The new CFRunLoopSource object. You are responsible for releasing this object.

- (`Object`) CFRunLoopSourceGetContext(source, context)

Returns the context information for a CFRunLoopSource object.

Parameters:

source (CFRunLoopSourceRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFRunLoopSourceContext) —

A priority index indicating the order in which run loop sources are processed. When multiple run loop sources are firing in a single pass through the run loop, the sources are processed in increasing order of this parameter. If the run loop is set to process only one source per loop, only the highest priority source, the one with the lowest order value, is processed. This value is ignored for version 1 sources. Pass 0 unless there is a reason to do otherwise.

Returns:

(Object) —

The ordering parameter for source, which the run loop uses (for version 0 sources only) to determine the order in which sources are processed when multiple sources are firing.

- (`CFIndex`) CFRunLoopSourceGetOrder(source)

Returns the ordering parameter for a CFRunLoopSource object.

Parameters:

source (CFRunLoopSourceRef) —

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

Returns:

(CFIndex) —

The type identifier for the CFRunLoopSource opaque type.

- (`CFTypeID`) CFRunLoopSourceGetTypeID

Returns the type identifier of the CFRunLoopSource opaque type.

Returns:

(CFTypeID) —

true if source is valid, otherwise false.

- (`nil`) CFRunLoopSourceInvalidate(source)

Invalidates a CFRunLoopSource object, stopping it from ever firing again.

Parameters:

source (CFRunLoopSourceRef) —

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

Returns:

(nil)

- (`Boolean`) CFRunLoopSourceIsValid(source)

Returns a Boolean value that indicates whether a CFRunLoopSource object is valid and able to fire.

Parameters:

source (CFRunLoopSourceRef) —

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

Returns:

(Boolean)

- (`nil`) CFRunLoopSourceSignal(source)

Signals a CFRunLoopSource object, marking it as ready to fire.

Parameters:

source (CFRunLoopSourceRef) —

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

Returns:

(nil)

- (`nil`) CFRunLoopStop(rl)

Forces a CFRunLoop object to stop running.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.

Returns:

(nil)

- (`CFRunLoopTimerRef`) CFRunLoopTimerCreate(allocator, fireDate, interval, flags, order, callout, context)

Creates a new CFRunLoopTimer object.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
fireDate (CFAbsoluteTime) —

The time at which the timer should first fire. The fine precision (sub-millisecond at most) of the fire date may be adjusted slightly by the timer if there are implementation reasons to do.
interval (CFTimeInterval) —

The firing interval of the timer. If 0 or negative, the timer fires once and then is automatically invalidated. The fine precision (sub-millisecond at most) of the interval may be adjusted slightly by the timer if implementation reasons to do so exist.
flags (CFOptionFlags) —

Currently ignored. Pass 0 for future compatibility.
order (CFIndex) —

A priority index indicating the order in which run loop timers are processed. Run loop timers currently ignore this parameter. Pass 0.
callout (CFRunLoopTimerCallBack) —

The callback function that is called when the timer fires.
context (CFRunLoopTimerContext) —

A structure holding contextual information for the run loop timer. The function copies the information out of the structure, so the memory pointed to by context does not need to persist beyond the function call. Can be NULL if the callback function does not need the context’s info pointer to keep track of state.

Returns:

(CFRunLoopTimerRef) —

The new CFRunLoopTimer object. Ownership follows the Create Rule.

- (`Boolean`) CFRunLoopTimerDoesRepeat(timer)

Returns a Boolean value that indicates whether a CFRunLoopTimer object repeats.

Parameters:

timer (CFRunLoopTimerRef) —

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

Returns:

(Boolean) —

true if timer repeats, or has a periodicity; otherwise false.

- (`Object`) CFRunLoopTimerGetContext(timer, context)

Returns the context information for a CFRunLoopTimer object.

Parameters:

timer (CFRunLoopTimerRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (CFRunLoopTimerContext) —

The time at which the timer should first fire. The fine precision (sub-millisecond at most) of the fire date may be adjusted slightly by the timer if there are implementation reasons to do.

Returns:

(Object) —

The firing interval of timer. Returns 0 if timer does not repeat.

- (`CFTimeInterval`) CFRunLoopTimerGetInterval(timer)

Returns the firing interval of a repeating CFRunLoopTimer object.

Parameters:

timer (CFRunLoopTimerRef) —

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

Returns:

(CFTimeInterval) —

The next firing time for timer. This time could be a date in the past if a run loop has not been able to process the timer since the firing time arrived.

- (`CFAbsoluteTime`) CFRunLoopTimerGetNextFireDate(timer)

Returns the next firing time for a CFRunLoopTimer object.

Parameters:

timer (CFRunLoopTimerRef) —

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

Returns:

(CFAbsoluteTime) —

The ordering parameter for timer.

- (`CFIndex`) CFRunLoopTimerGetOrder(timer)

Returns the ordering parameter for a CFRunLoopTimer object.

Parameters:

timer (CFRunLoopTimerRef) —

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

Returns:

(CFIndex) —

The type identifier for the CFRunLoopTimer opaque type.

- (`CFTypeID`) CFRunLoopTimerGetTypeID

Returns the type identifier of the CFRunLoopTimer opaque type.

Returns:

(CFTypeID) —

true if timer is valid; otherwise false.

- (`nil`) CFRunLoopTimerInvalidate(timer)

Invalidates a CFRunLoopTimer object, stopping it from ever firing again.

Parameters:

timer (CFRunLoopTimerRef) —

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

Returns:

(nil)

- (`Boolean`) CFRunLoopTimerIsValid(timer)

Returns a Boolean value that indicates whether a CFRunLoopTimer object is valid and able to fire.

Parameters:

timer (CFRunLoopTimerRef) —

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

Returns:

(Boolean)

- (`nil`) CFRunLoopTimerSetNextFireDate(timer, fireDate)

Sets the next firing date for a CFRunLoopTimer object .

Parameters:

timer (CFRunLoopTimerRef) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
fireDate (CFAbsoluteTime) —

The time at which the timer should first fire. The fine precision (sub-millisecond at most) of the fire date may be adjusted slightly by the timer if there are implementation reasons to do.

Returns:

(nil)

- (`nil`) CFRunLoopWakeUp(rl)

Wakes a waiting CFRunLoop object.

Parameters:

rl (CFRunLoopRef) —

The run loop to modify. Each run loop has its own independent list of modes that are in the set of common modes.

Returns:

(nil)

- (`Object`) CFSetAddValue(theSet, value)

Adds a value to a CFMutableSet object.

Parameters:

theSet (CFMutableSetRef) —

The set to modify.
value (Object) —

A CFType object or a pointer value to add to theSet (or the value itself, if it fits into the size of a pointer). value is retained by theSet using the retain callback provided when theSet was created. If value is not of the type expected by the retain callback, the behavior is undefined. If value already exists in the collection, this function returns without doing anything.

Returns:

(Object) —

A new mutable set, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFSetApplyFunction(theSet, applier, context)

Calls a function once for each value in a set.

Parameters:

theSet (CFSetRef) —

The set to operate upon.
applier (CFSetApplierFunction) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.
context (Object) —

A pointer-sized program-defined value, which is passed as the second parameter to the applier function, but is otherwise unused by this function.

Returns:

(Object) —

true if value is contained in theSet, otherwise false.

- (`Boolean`) CFSetContainsValue(theSet, value)

Returns a Boolean that indicates whether a set contains a given value.

Parameters:

theSet (CFSetRef) —

The set to operate upon.
value (Object) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.

Returns:

(Boolean) —

A new immutable set, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFSetRef`) CFSetCreate(allocator, values, numValues, callBacks)

Creates an immutable CFSet object containing supplied values.

Parameters:

allocator (CFAllocatorRef) —

The set to operate upon.
values (Pointer) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.
numValues (CFIndex) —

A pointer-sized program-defined value, which is passed as the second parameter to the applier function, but is otherwise unused by this function.
callBacks (const CFSetCallBacks) —

The set to search.

Returns:

(CFSetRef) —

A new set that contains the same values as theSet, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`CFSetRef`) CFSetCreateCopy(allocator, theSet)

Creates an immutable set containing the values of an existing set.

Parameters:

allocator (CFAllocatorRef) —

The set to operate upon.
theSet (CFSetRef) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.

Returns:

(CFSetRef) —

The number of values in theSet.

- (`CFMutableSetRef`) CFSetCreateMutable(allocator, capacity, callBacks)

Creates an empty CFMutableSet object.

Parameters:

allocator (CFAllocatorRef) —

The set to modify.
capacity (CFIndex) —

A CFType object or a pointer value to add to theSet (or the value itself, if it fits into the size of a pointer). value is retained by theSet using the retain callback provided when theSet was created. If value is not of the type expected by the retain callback, the behavior is undefined. If value already exists in the collection, this function returns without doing anything.
callBacks (const CFSetCallBacks) —

The allocator to use to allocate memory for the new set and its storage for values. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFMutableSetRef) —

A new mutable set that contains the same values as theSet. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFMutableSetRef`) CFSetCreateMutableCopy(allocator, capacity, theSet)

Creates a new mutable set with the values from another set.

Parameters:

allocator (CFAllocatorRef) —

The set to modify.
capacity (CFIndex) —

A CFType object or a pointer value to add to theSet (or the value itself, if it fits into the size of a pointer). value is retained by theSet using the retain callback provided when theSet was created. If value is not of the type expected by the retain callback, the behavior is undefined. If value already exists in the collection, this function returns without doing anything.
theSet (CFSetRef) —

The allocator to use to allocate memory for the new set and its storage for values. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(CFMutableSetRef)

- (`CFIndex`) CFSetGetCount(theSet)

Returns the number of values currently in a set.

Parameters:

theSet (CFSetRef) —

The set to operate upon.

Returns:

(CFIndex) —

The number of times value occurs in theSet. By definition, sets can not contain duplicate values, so returns 1 if value is contained in theSet, otherwise 0.

- (`CFIndex`) CFSetGetCountOfValue(theSet, value)

Returns the number of values in a set that match a given value.

Parameters:

theSet (CFSetRef) —

The set to operate upon.
value (Object) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.

Returns:

(CFIndex) —

The type identifier for the CFSet type.

- (`CFTypeID`) CFSetGetTypeID

Returns the type identifier for the CFSet type.

Returns:

(CFTypeID) —

A pointer to the requested value, or NULL if the value is not in theSet. If the value is a Core Foundation object, Ownership follows the Get Rule.

- (`const`) CFSetGetValue(theSet, value)

Obtains a specified value from a set.

Parameters:

theSet (CFSetRef) —

The set to operate upon.
value (Object) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.

Returns:

(const) —

true if value exists in theSet, otherwise false.

- (`Boolean`) CFSetGetValueIfPresent(theSet, candidate, value)

Reports whether or not a value is in a set, and if it exists returns the value indirectly.

Parameters:

theSet (CFSetRef) —

The set to operate upon.
candidate (Object) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.
value (Pointer) —

A pointer-sized program-defined value, which is passed as the second parameter to the applier function, but is otherwise unused by this function.

Returns:

(Boolean)

- (`nil`) CFSetGetValues(theSet, values)

Obtains all values in a set.

Parameters:

theSet (CFSetRef) —

The set to operate upon.
values (Pointer) —

The callback function to call once for each value in the theSet. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. The applier function must be able to work with all values in theSet.

Returns:

(nil)

- (`nil`) CFSetRemoveAllValues(theSet)

Removes all values from a CFMutableSet object.

Parameters:

theSet (CFMutableSetRef) —

The set to modify.

Returns:

(nil)

- (`nil`) CFSetRemoveValue(theSet, value)

Removes a value from a CFMutableSet object.

Parameters:

theSet (CFMutableSetRef) —

The set to modify.
value (Object) —

A CFType object or a pointer value to add to theSet (or the value itself, if it fits into the size of a pointer). value is retained by theSet using the retain callback provided when theSet was created. If value is not of the type expected by the retain callback, the behavior is undefined. If value already exists in the collection, this function returns without doing anything.

Returns:

(nil)

- (`nil`) CFSetReplaceValue(theSet, value)

Replaces a value in a CFMutableSet object.

Parameters:

theSet (CFMutableSetRef) —

The set to modify.
value (Object) —

A CFType object or a pointer value to add to theSet (or the value itself, if it fits into the size of a pointer). value is retained by theSet using the retain callback provided when theSet was created. If value is not of the type expected by the retain callback, the behavior is undefined. If value already exists in the collection, this function returns without doing anything.

Returns:

(nil)

- (`nil`) CFSetSetValue(theSet, value)

Sets a value in a CFMutableSet object.

Parameters:

theSet (CFMutableSetRef) —

The set to modify.
value (Object) —

A CFType object or a pointer value to add to theSet (or the value itself, if it fits into the size of a pointer). value is retained by theSet using the retain callback provided when theSet was created. If value is not of the type expected by the retain callback, the behavior is undefined. If value already exists in the collection, this function returns without doing anything.

Returns:

(nil)

- (`nil`) CFShow(obj)

Prints a description of a Core Foundation object to stderr.

Parameters:

obj (CFTypeRef) —

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Returns:

(nil)

- (`Object`) CFShowStr(str)

Prints the attributes of a string during debugging.

Parameters:

str (CFStringRef) —

The string whose attributes you want to print.

Returns:

(Object) —

An immutable string, or NULL if there was a problem creating the object. The returned object is a constant. You may retain and release it, similar to other immutable CFString objects, but are not required to do so—it will remain valid until the program terminates.

- (`CFSocketError`) CFSocketConnectToAddress(s, address, timeout)

Opens a connection to a remote socket.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
address (CFDataRef) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
timeout (CFTimeInterval) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.

Returns:

(CFSocketError) —

An error code indicating success or failure of the connection attempt.

- (`CFDataRef`) CFSocketCopyAddress(s)

Returns the local address of a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.

Returns:

(CFDataRef) —

The local address, stored as a struct sockaddr appropriate for the protocol family (struct sockaddr_in or struct sockaddr_in6, for example) in a CFData object, of s. Ownership follows the Create Rule.

- (`CFDataRef`) CFSocketCopyPeerAddress(s)

Returns the remote address to which a CFSocket object is connected.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.

Returns:

(CFDataRef) —

The remote address, stored as a struct sockaddr appropriate for the protocol family (struct sockaddr_in or struct sockaddr_in6, for example) in a CFData object, to which s is connected. Ownership follows the Create Rule.

- (`CFSocketError`) CFSocketCopyRegisteredSocketSignature(nameServerSignature, timeout, name, signature, nameServerAddress)

Returns a socket signature registered with a CFSocket name server.

Parameters:

nameServerSignature (const CFSocketSignature) —

The socket signature for the name server. If NULL, this function contacts the default server, which is assumed to be a local process using TCP/IP to listen on the port number returned from CFSocketGetDefaultNameRegistryPortNumber. If nameServerSignature is incomplete, the missing values are replaced with the default server’s values, if appropriate.
timeout (CFTimeInterval) —

The time to wait for the server to accept a connection and to reply to the registration request.
name (CFStringRef) —

The name of the registered socket signature to retrieve.
signature (CFSocketSignature) —

A pointer to a CFSocketSignature structure into which the retrieved socket signature is copied.
nameServerAddress (CFDataRef) —

A pointer to a CFData object into which the name server’s address is copied. Pass NULL if you do not want the server’s address.

Returns:

(CFSocketError) —

An error code indicating success or failure.

- (`CFSocketError`) CFSocketCopyRegisteredValue(nameServerSignature, timeout, name, value, nameServerAddress)

Returns a value registered with a CFSocket name server.

Parameters:

nameServerSignature (const CFSocketSignature) —

The socket signature for the name server. If NULL, this function contacts the default server, which is assumed to be a local process using TCP/IP to listen on the port number returned from CFSocketGetDefaultNameRegistryPortNumber. If nameServerSignature is incomplete, the missing values are replaced with the default server’s values, if appropriate.
timeout (CFTimeInterval) —

The time to wait for the server to accept a connection and to reply to the registration request.
name (CFStringRef) —

The name of the registered socket signature to retrieve.
value (CFPropertyListRef) —

A pointer to a CFSocketSignature structure into which the retrieved socket signature is copied.
nameServerAddress (CFDataRef) —

A pointer to a CFData object into which the name server’s address is copied. Pass NULL if you do not want the server’s address.

Returns:

(CFSocketError) —

An error code indicating success or failure.

- (`CFSocketRef`) CFSocketCreate(allocator, protocolFamily, socketType, protocol, callBackTypes, callout, context)

Creates a CFSocket object of a specified protocol and type.

Parameters:

allocator (CFAllocatorRef) —

The CFSocket object with which to connect to address.
protocolFamily (SInt32) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
socketType (SInt32) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.
protocol (SInt32) —

The CFSocket object to examine.
callBackTypes (CFOptionFlags) —

The CFSocket object to examine.
callout (CFSocketCallBack) —

The allocator to use to allocate memory for the new object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
context (const CFSocketContext) —

The protocol family for the socket. If negative or 0 is passed, the socket defaults to PF_INET.

Returns:

(CFSocketRef) —

The new CFSocket object, or NULL if an error occurred. Ownership follows the Create Rule.

- (`CFSocketRef`) CFSocketCreateConnectedToSocketSignature(allocator, signature, callBackTypes, callout, context, timeout)

Creates a CFSocket object and opens a connection to a remote socket.

Parameters:

allocator (CFAllocatorRef) —

The CFSocket object with which to connect to address.
signature (const CFSocketSignature) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
callBackTypes (CFOptionFlags) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.
callout (CFSocketCallBack) —

The CFSocket object to examine.
context (const CFSocketContext) —

The CFSocket object to examine.
timeout (CFTimeInterval) —

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

Returns:

(CFSocketRef) —

The new CFSocket object, or NULL if an error occurred. Ownership follows the Create Rule.

- (`CFRunLoopSourceRef`) CFSocketCreateRunLoopSource(allocator, s, order)

Creates a CFRunLoopSource object for a CFSocket object.

Parameters:

allocator (CFAllocatorRef) —

The CFSocket object with which to connect to address.
s (CFSocketRef) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
order (CFIndex) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.

Returns:

(CFRunLoopSourceRef) —

The new CFRunLoopSource object for s. Ownership follows the Create Rule.

- (`CFSocketRef`) CFSocketCreateWithNative(allocator, sock, callBackTypes, callout, context)

Creates a CFSocket object for a pre-existing native socket.

Parameters:

allocator (CFAllocatorRef) —

The CFSocket object with which to connect to address.
sock (CFSocketNativeHandle) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
callBackTypes (CFOptionFlags) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.
callout (CFSocketCallBack) —

The CFSocket object to examine.
context (const CFSocketContext) —

The CFSocket object to examine.

Returns:

(CFSocketRef) —

The new CFSocket object, or NULL if an error occurred. If a CFSocket object already exists for sock, the function returns the pre-existing object instead of creating a new object; the context, callout, and callBackTypes parameters are ignored in this case. Ownership follows the Create Rule.

- (`CFSocketRef`) CFSocketCreateWithSocketSignature(allocator, signature, callBackTypes, callout, context)

Creates a CFSocket object using information from a CFSocketSignature structure.

Parameters:

allocator (CFAllocatorRef) —

The CFSocket object with which to connect to address.
signature (const CFSocketSignature) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
callBackTypes (CFOptionFlags) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.
callout (CFSocketCallBack) —

The CFSocket object to examine.
context (const CFSocketContext) —

The CFSocket object to examine.

Returns:

(CFSocketRef) —

The new CFSocket object, or NULL if an error occurred. Ownership follows the Create Rule.

- (`Object`) CFSocketDisableCallBacks(s, callBackTypes)

Disables the callback function of a CFSocket object for certain types of socket activity.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
callBackTypes (CFOptionFlags) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.

Returns:

(Object) —

The native socket associated with s. If s has been invalidated, returns -1, INVALID_SOCKET.

- (`Object`) CFSocketEnableCallBacks(s, callBackTypes)

Enables the callback function of a CFSocket object for certain types of socket activity.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
callBackTypes (CFOptionFlags) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.

Returns:

(Object) —

A bitwise-OR combination of flags controlling the behavior of s. See “CFSocket Flags” for the list of available flags.

- (`Object`) CFSocketGetContext(s, context)

Returns the context information for a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
context (CFSocketContext) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.

Returns:

(Object) —

The type identifier for the CFSocket opaque type.

- (`UInt16`) CFSocketGetDefaultNameRegistryPortNumber

Returns the default port number with which to connect to a CFSocket name server.

Returns:

(UInt16) —

The default port number with which to connect to a CFSocket name server.

- (`CFSocketNativeHandle`) CFSocketGetNative(s)

Returns the native socket associated with a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.

Returns:

(CFSocketNativeHandle) —

true if s can be used for communication, otherwise false.

- (`CFOptionFlags`) CFSocketGetSocketFlags(s)

Returns flags that control certain behaviors of a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.

Returns:

(CFOptionFlags) —

An error code indicating success or failure.

- (`nil`) CFSocketInvalidate(s)

Invalidates a CFSocket object, stopping it from sending or receiving any more messages.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.

Returns:

(nil)

- (`Boolean`) CFSocketIsValid(s)

Returns a Boolean value that indicates whether a CFSocket object is valid and able to send or receive messages.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.

Returns:

(Boolean)

- (`CFSocketError`) CFSocketRegisterSocketSignature(nameServerSignature, timeout, name, signature)

Registers a socket signature with a CFSocket name server.

Parameters:

nameServerSignature (const CFSocketSignature) —

The socket signature for the name server. If NULL, this function contacts the default server, which is assumed to be a local process using TCP/IP to listen on the port number returned from CFSocketGetDefaultNameRegistryPortNumber. If nameServerSignature is incomplete, the missing values are replaced with the default server’s values, if appropriate.
timeout (CFTimeInterval) —

The time to wait for the server to accept a connection and to reply to the registration request.
name (CFStringRef) —

The name of the registered socket signature to retrieve.
signature (const CFSocketSignature) —

A pointer to a CFSocketSignature structure into which the retrieved socket signature is copied.

Returns:

(CFSocketError) —

An error code indicating success or failure.

- (`CFSocketError`) CFSocketRegisterValue(nameServerSignature, timeout, name, value)

Registers a property-list value with a CFSocket name server.

Parameters:

nameServerSignature (const CFSocketSignature) —

The socket signature for the name server. If NULL, this function contacts the default server, which is assumed to be a local process using TCP/IP to listen on the port number returned from CFSocketGetDefaultNameRegistryPortNumber. If nameServerSignature is incomplete, the missing values are replaced with the default server’s values, if appropriate.
timeout (CFTimeInterval) —

The time to wait for the server to accept a connection and to reply to the registration request.
name (CFStringRef) —

The name of the registered socket signature to retrieve.
value (CFPropertyListRef) —

A pointer to a CFSocketSignature structure into which the retrieved socket signature is copied.

Returns:

(CFSocketError) —

An error code indicating success or failure.

- (`CFSocketError`) CFSocketSendData(s, address, data, timeout)

Sends data over a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
address (CFDataRef) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.
data (CFDataRef) —

The time to wait for a connection to succeed. If a negative value is used, this function does not wait for the connection and instead lets the connection attempt happen in the background. If s requested a kCFSocketConnectCallBack, you will receive a callback when the background connection succeeds or fails.
timeout (CFTimeInterval) —

The CFSocket object to examine.

Returns:

(CFSocketError)

- (`CFSocketError`) CFSocketSetAddress(s, address)

Binds a local address to a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
address (CFDataRef) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.

Returns:

(CFSocketError)

- (`Object`) CFSocketSetDefaultNameRegistryPortNumber(port)

Sets the default port number with which to connect to a CFSocket name server.

Parameters:

port (UInt16) —

The socket signature for the name server. If NULL, this function contacts the default server, which is assumed to be a local process using TCP/IP to listen on the port number returned from CFSocketGetDefaultNameRegistryPortNumber. If nameServerSignature is incomplete, the missing values are replaced with the default server’s values, if appropriate.

Returns:

(Object) —

An error code indicating success or failure.

- (`nil`) CFSocketSetSocketFlags(s, flags)

Sets flags that control certain behaviors of a CFSocket object.

Parameters:

s (CFSocketRef) —

The CFSocket object with which to connect to address.
flags (CFOptionFlags) —

A CFData object containing a struct sockaddr appropriate for the protocol family of s (struct sockaddr_in or struct sockaddr_in6, for example), indicating the remote address to which to connect.

Returns:

(nil)

- (`CFSocketError`) CFSocketUnregister(nameServerSignature, timeout, name)

Unregisters a value or socket signature with a CFSocket name server.

Parameters:

nameServerSignature (const CFSocketSignature) —

The socket signature for the name server. If NULL, this function contacts the default server, which is assumed to be a local process using TCP/IP to listen on the port number returned from CFSocketGetDefaultNameRegistryPortNumber. If nameServerSignature is incomplete, the missing values are replaced with the default server’s values, if appropriate.
timeout (CFTimeInterval) —

The time to wait for the server to accept a connection and to reply to the registration request.
name (CFStringRef) —

The name of the registered socket signature to retrieve.

Returns:

(CFSocketError)

- (`CFStringRef`) CFSTR(cStr)

Creates an immutable string from a constant compile-time string.

Parameters:

cStr (const char) —

The string whose attributes you want to print.

Returns:

(CFStringRef) —

A Comparison Results value that indicates whether theString1 is equal to, less than, or greater than theString2.

- (`nil`) CFStreamCreateBoundPair(alloc, readStream, writeStream, transferBufferSize)

Creates a pair of read and write streams.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.
readStream (CFReadStreamRef) —

Upon return, a readable stream. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
writeStream (CFWriteStreamRef) —

Upon return, a writable. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
transferBufferSize (CFIndex) —

The size of the buffer to use to transfer data from readStream to writeStream.

Returns:

(nil)

- (`nil`) CFStreamCreatePairWithPeerSocketSignature(alloc, signature, readStream, writeStream)

Creates readable and writable streams connected to a socket.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.
signature (const CFSocketSignature) —

Upon return, a readable stream. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
readStream (CFReadStreamRef) —

Upon return, a writable. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
writeStream (CFWriteStreamRef) —

The size of the buffer to use to transfer data from readStream to writeStream.

Returns:

(nil)

- (`nil`) CFStreamCreatePairWithSocket(alloc, sock, readStream, writeStream)

Creates readable and writable streams connected to a socket.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.
sock (CFSocketNativeHandle) —

Upon return, a readable stream. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
readStream (CFReadStreamRef) —

Upon return, a writable. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
writeStream (CFWriteStreamRef) —

The size of the buffer to use to transfer data from readStream to writeStream.

Returns:

(nil)

- (`nil`) CFStreamCreatePairWithSocketToHost(alloc, host, port, readStream, writeStream)

Creates readable and writable streams connected to a TCP/IP port of a particular host.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.
host (CFStringRef) —

Upon return, a readable stream. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
port (UInt32) —

Upon return, a writable. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.
readStream (CFReadStreamRef) —

The size of the buffer to use to transfer data from readStream to writeStream.
writeStream (CFWriteStreamRef) —

The allocator to use to allocate memory for the new objects. Pass NULL or kCFAllocatorDefault to use the current default allocator.

Returns:

(nil)

- (`Object`) CFStringAppend(theString, appendedString)

Appends the characters of a string to those of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
appendedString (CFStringRef) —

The string to append.

Returns:

(Object) —

A new empty CFMutableString object or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`Object`) CFStringAppendCharacters(theString, chars, numChars)

Appends a buffer of Unicode characters to the character contents of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
chars (const UniChar) —

The string to append.
numChars (CFIndex) —

The string to which the characters in chars are appended.

Returns:

(Object) —

A string that has the same contents as theString. Returns NULL if there was a problem copying the object. Ownership follows the Create Rule.

- (`Object`) CFStringAppendCString(theString, cStr, encoding)

Appends a C string to the character contents of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
cStr (const char) —

The string to append.
encoding (CFStringEncoding) —

The string to which the characters in chars are appended.

Returns:

(Object) —

A new mutable string, or NULL if there was a problem creating the object. Ownership follows the Create Rule.

- (`Object`) CFStringAppendFormat(theString, formatOptions, format)

Appends a formatted string to the character contents of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
formatOptions (CFDictionaryRef) —

The string to append.
format (CFStringRef) —

The string to which the characters in chars are appended.

Returns:

(Object) —

The number of instances of stringToFind that were replaced.

- (`Object`) CFStringAppendFormatAndArguments(theString, formatOptions, format, arguments)

Appends a formatted string to the character contents of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
formatOptions (CFDictionaryRef) —

The string to append.
format (CFStringRef) —

The string to which the characters in chars are appended.
arguments (va_list) —

A pointer to a buffer of Unicode characters.

Returns:

(Object) —

true if the transform is successful; otherwise false.

- (`nil`) CFStringAppendPascalString(theString, pStr, encoding)

Appends a Pascal string to the character contents of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
pStr (ConstStr255Param) —

The string to append.
encoding (CFStringEncoding) —

The string to which the characters in chars are appended.

Returns:

(nil)

- (`nil`) CFStringCapitalize(theString, locale)

Changes the first character in each word of a string to uppercase (if it is a lowercase alphabetical character).

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
locale (CFLocaleRef) —

The string to append.

Returns:

(nil)

- (`CFComparisonResult`) CFStringCompare(theString1, theString2, compareOptions)

Compares one string with another string.

Parameters:

theString1 (CFStringRef) —

The string whose attributes you want to print.
theString2 (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
compareOptions (CFStringCompareFlags) —

The first string to use in the comparison.

Returns:

(CFComparisonResult) —

A Comparison Results value that indicates whether theString1 is equal to, less than, or greater than theString2.

- (`CFComparisonResult`) CFStringCompareWithOptions(theString1, theString2, rangeToCompare, compareOptions)

Compares a range of the characters in one string with that of another string.

Parameters:

theString1 (CFStringRef) —

The string whose attributes you want to print.
theString2 (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
rangeToCompare (CFRange) —

The first string to use in the comparison.
compareOptions (CFStringCompareFlags) —

The second string to use in the comparison.

Returns:

(CFComparisonResult) —

A Comparison Results value that indicates whether theString1 is equal to, less than, or greater than theString2.

- (`CFComparisonResult`) CFStringCompareWithOptionsAndLocale(theString1, theString2, rangeToCompare, compareOptions, locale)

Compares a range of the characters in one string with another string using a given locale.

Parameters:

theString1 (CFStringRef) —

The string whose attributes you want to print.
theString2 (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
rangeToCompare (CFRange) —

The first string to use in the comparison.
compareOptions (CFStringCompareFlags) —

The second string to use in the comparison.
locale (CFLocaleRef) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(CFComparisonResult) —

The name of the IANA “charset” that is the closest mapping to encoding. Returns NULL if the encoding is not recognized.

- (`CFStringRef`) CFStringConvertEncodingToIANACharSetName(encoding)

Returns the name of the IANA registry “charset” that is the closest mapping to a specified string encoding.

Parameters:

encoding (CFStringEncoding) —

The string whose attributes you want to print.

Returns:

(CFStringRef) —

The Cocoa encoding (of type NSStringEncoding) that is closest to the Core Foundation encoding encoding. The behavior is undefined if an invalid string encoding is passed.

- (`unsigned`) CFStringConvertEncodingToNSStringEncoding(encoding)

Returns the Cocoa encoding constant that maps most closely to a given Core Foundation encoding constant.

Parameters:

encoding (CFStringEncoding) —

The string whose attributes you want to print.

Returns:

(unsigned) —

The Windows codepage value that is closest to the Core Foundation encoding encoding. The behavior is undefined if an invalid string encoding is passed.

- (`UInt32`) CFStringConvertEncodingToWindowsCodepage(encoding)

Returns the Windows codepage identifier that maps most closely to a given Core Foundation encoding constant.

Parameters:

encoding (CFStringEncoding) —

The string whose attributes you want to print.

Returns:

(UInt32) —

The Core Foundation string encoding that is closest to the IANA “charset” IANAName. Returns the kCFStringEncodingInvalidId constant if the name is not recognized.

- (`CFStringEncoding`) CFStringConvertIANACharSetNameToEncoding(theString)

Returns the Core Foundation encoding constant that is the closest mapping to a given IANA registry “charset” name.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.

Returns:

(CFStringEncoding) —

The Core Foundation string encoding that is closest to the Cocoa string encoding encoding. Returns the kCFStringEncodingInvalidId constant if the mapping is not known.

- (`CFStringEncoding`) CFStringConvertNSStringEncodingToEncoding(encoding)

Returns the Core Foundation encoding constant that is the closest mapping to a given Cocoa encoding.

Parameters:

encoding (Integer) —

The string whose attributes you want to print.

Returns:

(CFStringEncoding) —

The Core Foundation string encoding that is closest to the Windows codepage identifier codepage. Returns the kCFStringEncodingInvalidId constant if the mapping is not known.

- (`CFStringEncoding`) CFStringConvertWindowsCodepageToEncoding(codepage)

Returns the Core Foundation encoding constant that is the closest mapping to a given Windows codepage identifier.

Parameters:

codepage (UInt32) —

The string whose attributes you want to print.

Returns:

(CFStringEncoding) —

A new array that contains CFString objects that represent substrings of theString, or NULL if there was a problem creating the object. The order of elements in the array is identical to the order of the substrings in theString. If separatorString does not occur in theString, the result is an array containing theString. If separatorString is equal to theString, then the result is an array containing two empty strings. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFStringCreateArrayBySeparatingStrings(alloc, theString, separatorString)

Creates an array of CFString objects from a single CFString object.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
theString (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
separatorString (CFStringRef) —

The first string to use in the comparison.

Returns:

(CFArrayRef) —

An array that contains pointers to CFRange structures identifying the character locations of stringToFind in theString. Returns NULL, if no matching substring is found in the source object, or if there was a problem creating the array. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFArrayRef`) CFStringCreateArrayWithFindResults(alloc, theString, stringToFind, rangeToSearch, compareOptions)

Searches a string for multiple occurrences of a substring and creates an array of ranges identifying the locations of these substrings within the target string.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
theString (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
stringToFind (CFStringRef) —

The first string to use in the comparison.
rangeToSearch (CFRange) —

The second string to use in the comparison.
compareOptions (CFStringCompareFlags) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(CFArrayRef) —

A string that contains a concatenation of the strings in theArray separated by separatorString. The order of the substrings in the string is identical to the order of the elements in theArray.

- (`CFStringRef`) CFStringCreateByCombiningStrings(alloc, theArray, separatorString)

Creates a single string from the individual CFString objects that comprise the elements of an array.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
theArray (CFArrayRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
separatorString (CFStringRef) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

If theArray is empty, returns an empty CFString object; if theArray contains one CFString object, that object is returned (without the separator string). Returns NULL if there was a problem in creating the string. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateCopy(alloc, theString)

Creates an immutable copy of a string.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
theString (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(CFStringRef) —

An immutable string whose contents are identical to theString. Returns NULL if there was a problem copying the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFDataRef`) CFStringCreateExternalRepresentation(alloc, theString, encoding, lossByte)

Creates an “external representation” of a CFString object, that is, a CFData object.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
theString (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.
lossByte (UInt8) —

The second string to use in the comparison.

Returns:

(CFDataRef) —

A CFData object that stores the characters of the CFString object as an “external representation.” Returns NULL if no loss byte was specified and the function could not convert the characters to the specified encoding. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateFromExternalRepresentation(alloc, data, encoding)

Creates a string from its “external representation.”

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
data (CFDataRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing the characters from data, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFMutableStringRef`) CFStringCreateMutable(alloc, maxLength)

Creates an empty CFMutableString object.

Parameters:

alloc (CFAllocatorRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
maxLength (CFIndex) —

The string to append.

Returns:

(CFMutableStringRef)

- (`CFMutableStringRef`) CFStringCreateMutableCopy(alloc, maxLength, theString)

Creates a mutable copy of a string.

Parameters:

alloc (CFAllocatorRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
maxLength (CFIndex) —

The string to append.
theString (CFStringRef) —

The string to which the characters in chars are appended.

Returns:

(CFMutableStringRef)

- (`CFMutableStringRef`) CFStringCreateMutableWithExternalCharactersNoCopy(alloc, chars, numChars, capacity, externalCharactersAllocator)

Creates a CFMutableString object whose Unicode character buffer is controlled externally.

Parameters:

alloc (CFAllocatorRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
chars (UniChar) —

The string to append.
numChars (CFIndex) —

The string to which the characters in chars are appended.
capacity (CFIndex) —

A pointer to a buffer of Unicode characters.
externalCharactersAllocator (CFAllocatorRef) —

The number of Unicode characters in chars.

Returns:

(CFMutableStringRef)

- (`CFStringRef`) CFStringCreateWithBytes(alloc, bytes, numBytes, encoding, isExternalRepresentation)

Creates a string from a buffer containing characters in a specified encoding.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
bytes (const UInt8) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
numBytes (CFIndex) —

The first string to use in the comparison.
encoding (CFStringEncoding) —

The second string to use in the comparison.
isExternalRepresentation (Boolean) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(CFStringRef) —

An immutable string, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithBytesNoCopy(alloc, bytes, numBytes, encoding, isExternalRepresentation, contentsDeallocator)

Creates a string from a buffer, containing characters in a specified encoding, that might serve as the backing store for the new string.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
bytes (const UInt8) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
numBytes (CFIndex) —

The first string to use in the comparison.
encoding (CFStringEncoding) —

The second string to use in the comparison.
isExternalRepresentation (Boolean) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.
contentsDeallocator (CFAllocatorRef) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

A new string whose contents are bytes. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithCharacters(alloc, chars, numChars)

Creates a string from a buffer of Unicode characters.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
chars (const UniChar) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
numChars (CFIndex) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing chars, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithCharactersNoCopy(alloc, chars, numChars, contentsDeallocator)

Creates a string from a buffer of Unicode characters that might serve as the backing store for the object.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
chars (const UniChar) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
numChars (CFIndex) —

The first string to use in the comparison.
contentsDeallocator (CFAllocatorRef) —

The second string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing chars, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithCString(alloc, cStr, encoding)

Creates an immutable string from a C string.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
cStr (const char) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing cStr (after stripping off the NULL terminating character), or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithCStringNoCopy(alloc, cStr, encoding, contentsDeallocator)

Creates a CFString object from an external C string buffer that might serve as the backing store for the object.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
cStr (const char) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.
contentsDeallocator (CFAllocatorRef) —

The second string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing cStr (after stripping off the NULL terminating character), or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithFileSystemRepresentation(alloc, buffer)

Creates a CFString from a zero-terminated POSIX file system representation.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
buffer (const char) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(CFStringRef) —

A string that represents buffer. The result is NULL if there was a problem in creating the string (possible if the conversion fails due to bytes in the buffer not being a valid sequence of bytes for the appropriate character encoding). Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithFormat(alloc, formatOptions, format)

Creates an immutable string from a formatted string and a variable number of arguments.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
formatOptions (CFDictionaryRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
format (CFStringRef) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithFormatAndArguments(alloc, formatOptions, format, arguments)

Creates an immutable string from a formatted string and a variable number of arguments (specified in a parameter of type va_list).

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
formatOptions (CFDictionaryRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
format (CFStringRef) —

The first string to use in the comparison.
arguments (va_list) —

The second string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithPascalString(alloc, pStr, encoding)

Creates an immutable CFString object from a Pascal string.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
pStr (ConstStr255Param) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing pStr, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithPascalStringNoCopy(alloc, pStr, encoding, contentsDeallocator)

Creates a CFString object from an external Pascal string buffer that might serve as the backing store for the object.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
pStr (ConstStr255Param) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.
contentsDeallocator (CFAllocatorRef) —

The second string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string containing pStr, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFStringCreateWithSubstring(alloc, str, range)

Creates an immutable string from a segment (substring) of an existing string.

Parameters:

alloc (CFAllocatorRef) —

The string whose attributes you want to print.
str (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
range (CFRange) —

The first string to use in the comparison.

Returns:

(CFStringRef) —

An immutable string, or NULL if there was a problem creating the object. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`nil`) CFStringDelete(theString, range)

Deletes a range of characters in a string.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
range (CFRange) —

The string to append.

Returns:

(nil)

- (`CFRange`) CFStringFind(theString, stringToFind, compareOptions)

Searches for a substring within a string and, if it is found, yields the range of the substring within the object's characters.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
stringToFind (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
compareOptions (CFStringCompareFlags) —

The first string to use in the comparison.

Returns:

(CFRange) —

The range of the located substring within theString. If a match is not located, the returned CFRange structure will have a location of kCFNotFound and a length of 0 (either of which is enough to indicate failure).

- (`CFIndex`) CFStringFindAndReplace(theString, stringToFind, replacementString, rangeToSearch, compareOptions)

Replaces all occurrences of a substring within a given range.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
stringToFind (CFStringRef) —

The string to append.
replacementString (CFStringRef) —

The string to which the characters in chars are appended.
rangeToSearch (CFRange) —

A pointer to a buffer of Unicode characters.
compareOptions (CFOptionFlags) —

The number of Unicode characters in chars.

Returns:

(CFIndex)

- (`Boolean`) CFStringFindCharacterFromSet(theString, theSet, rangeToSearch, searchOptions, result)

Query the range of the first character contained in the specified character set.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
theSet (CFCharacterSetRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
rangeToSearch (CFRange) —

The first string to use in the comparison.
searchOptions (CFStringCompareFlags) —

The second string to use in the comparison.
result (CFRange) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(Boolean) —

true if a character in the character set is found and result is filled, false otherwise.

- (`Boolean`) CFStringFindWithOptions(theString, stringToFind, rangeToSearch, searchOptions, result)

Searches for a substring within a range of the characters represented by a string and, if the substring is found, returns its range within the object's characters.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
stringToFind (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
rangeToSearch (CFRange) —

The first string to use in the comparison.
searchOptions (CFStringCompareFlags) —

The second string to use in the comparison.
result (CFRange) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(Boolean) —

true if the substring was found, false otherwise.

- (`Boolean`) CFStringFindWithOptionsAndLocale(theString, stringToFind, rangeToSearch, searchOptions, locale, result)

Returns a Boolean value that indicates whether a given string was found in a given source string.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
stringToFind (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
rangeToSearch (CFRange) —

The first string to use in the comparison.
searchOptions (CFStringCompareFlags) —

The second string to use in the comparison.
locale (CFLocaleRef) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.
result (CFRange) —

The first string to use in the comparison.

Returns:

(Boolean) —

true if the substring was found, false otherwise.

- (`nil`) CFStringFold(theString, theFlags, theLocale)

Folds a given string into the form specified by optional flags.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
theFlags (CFOptionFlags) —

The string to append.
theLocale (CFLocaleRef) —

The string to which the characters in chars are appended.

Returns:

(nil)

- (`CFIndex`) CFStringGetBytes(theString, range, encoding, lossByte, isExternalRepresentation, buffer, maxBufLen, usedBufLen)

Fetches a range of the characters from a string into a byte buffer after converting the characters to a specified encoding.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
range (CFRange) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
encoding (CFStringEncoding) —

The first string to use in the comparison.
lossByte (UInt8) —

The second string to use in the comparison.
isExternalRepresentation (Boolean) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.
buffer (UInt8) —

The first string to use in the comparison.
maxBufLen (CFIndex) —

The second string to use in the comparison.
usedBufLen (CFIndex) —

The range of characters in theString1 to be used in the comparison to theString2. To use the whole string, pass the range CFRangeMake(0, CFStringGetLength(theString1)) or use CFStringCompare. The specified range must not exceed the length of the string.

Returns:

(CFIndex) —

The number of characters converted.

- (`UniChar`) CFStringGetCharacterAtIndex(theString, idx)

Returns the Unicode character at a specified location in a string.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
idx (CFIndex) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(UniChar) —

A Unicode character.

- (`UniChar`) CFStringGetCharacterFromInlineBuffer(buf, idx)

Returns the Unicode character at a specific location in an in-line buffer.

Parameters:

buf (CFStringInlineBuffer) —

The string whose attributes you want to print.
idx (CFIndex) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(UniChar) —

A Unicode character, or 0 if a location outside the original range is specified.

- (`Object`) CFStringGetCharacters(theString, range, buffer)

Copies a range of the Unicode characters from a string to a user-provided buffer.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
range (CFRange) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
buffer (UniChar) —

The first string to use in the comparison.

Returns:

(Object) —

A pointer to a buffer of Unicode character, or NULL if the internal storage of theString does not allow this to be returned efficiently.

- (`const`) CFStringGetCharactersPtr(theString)

Quickly obtains a pointer to the contents of a string as a buffer of Unicode characters.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.

Returns:

(const) —

true upon success or false if the conversion fails or the provided buffer is too small.

- (`Boolean`) CFStringGetCString(theString, buffer, bufferSize, encoding)

Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
buffer (Integer) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
bufferSize (CFIndex) —

The first string to use in the comparison.
encoding (CFStringEncoding) —

The second string to use in the comparison.

Returns:

(Boolean) —

A pointer to a C string or NULL if the internal storage of theString does not allow this to be returned efficiently.

- (`const`) CFStringGetCStringPtr(theString, encoding)

Quickly obtains a pointer to a C-string buffer containing the characters of a string in a given encoding.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
encoding (CFStringEncoding) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(const) —

The double value represented by str, or 0.0 if there is a scanning error (if the string contains disallowed characters or does not represent a double value).

- (`Float`) CFStringGetDoubleValue(str)

Returns the primary double value represented by a string.

Parameters:

str (CFStringRef) —

The string whose attributes you want to print.

Returns:

(Float) —

The string encoding to which theString can be converted the fastest.

- (`CFStringEncoding`) CFStringGetFastestEncoding(theString)

Returns for a CFString object the character encoding that requires the least conversion time.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.

Returns:

(CFStringEncoding) —

true if the string is correctly converted; false if the conversion fails, or the results don’t fit into the buffer.

- (`Boolean`) CFStringGetFileSystemRepresentation(string, buffer, maxBufLen)

Extracts the contents of a string as a NULL-terminated 8-bit string appropriate for passing to POSIX APIs.

Parameters:

string (CFStringRef) —

The string whose attributes you want to print.
buffer (Integer) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
maxBufLen (CFIndex) —

The first string to use in the comparison.

Returns:

(Boolean) —

An index in the string where it is appropriate to insert a hyphen, if one exists; otherwise, kCFNotFound.

- (`CFIndex`) CFStringGetHyphenationLocationBeforeIndex(string, location, limitRange, options, locale, character)

Retrieve the first potential hyphenation location found before the specified location.

Parameters:

string (CFStringRef) —

The string whose attributes you want to print.
location (CFIndex) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
limitRange (CFRange) —

The first string to use in the comparison.
options (CFOptionFlags) —

The second string to use in the comparison.
locale (CFLocaleRef) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.
character (UTF32Char) —

The first string to use in the comparison.

Returns:

(CFIndex) —

The signed integer value represented by str. The result is 0 if there is a scanning error (if the string contains disallowed characters or does not represent an integer value) or INT_MAX or INT_MIN if there is an overflow error.

- (`SInt32`) CFStringGetIntValue(str)

Returns the integer value represented by a string.

Parameters:

str (CFStringRef) —

The string whose attributes you want to print.

Returns:

(SInt32) —

The number (in terms of UTF-16 code pairs) of characters stored in theString.

- (`CFIndex`) CFStringGetLength(theString)

Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.

Returns:

(CFIndex) —

A pointer to a kCFStringEncodingInvalidId-terminated list of enum constants, each of type CFStringEncoding.

- (`Object`) CFStringGetLineBounds(theString, range, lineBeginIndex, lineEndIndex, contentsEndIndex)

Given a range of characters in a string, obtains the line bounds—that is, the indexes of the first character and the final characters of the lines containing the range.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
range (CFRange) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
lineBeginIndex (CFIndex) —

The first string to use in the comparison.
lineEndIndex (CFIndex) —

The second string to use in the comparison.
contentsEndIndex (CFIndex) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(Object) —

A UTF32Char that corresponds to the combination of surrogateHigh and surrogateLow.

- (`const`) CFStringGetListOfAvailableEncodings

Returns a pointer to a list of string encodings supported by the current system.

Returns:

(const) —

The maximum number of bytes that could be required to represent length number of Unicode characters with the string encoding encoding. The number of bytes that the encoding actually ends up requiring when converting any particular string could be less than this, but never more.

- (`UTF32Char`) CFStringGetLongCharacterForSurrogatePair(surrogateHigh, surrogateLow)

Returns a UTF-32 character that corresponds to a given pair of UTF-16 surrogate characters.

Parameters:

surrogateHigh (UniChar) —

The string whose attributes you want to print.
surrogateLow (UniChar) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(UTF32Char) —

The upper bound on the number of bytes required to hold the file system representation of the string.

- (`CFIndex`) CFStringGetMaximumSizeForEncoding(length, encoding)

Returns the maximum number of bytes a string of a specified length (in Unicode characters) will take up if encoded in a specified encoding.

Parameters:

length (CFIndex) —

The string whose attributes you want to print.
encoding (CFStringEncoding) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(CFIndex) —

The most compatible Mac OS script value for encoding.

- (`CFIndex`) CFStringGetMaximumSizeOfFileSystemRepresentation(string)

Determines the upper bound on the number of bytes required to hold the file system representation of the string.

Parameters:

string (CFStringRef) —

The string whose attributes you want to print.

Returns:

(CFIndex) —

Name of encoding; non-localized. Ownership follows the Get Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringEncoding`) CFStringGetMostCompatibleMacStringEncoding(encoding)

Returns the most compatible Mac OS script value for the given input encoding.

Parameters:

encoding (CFStringEncoding) —

The string whose attributes you want to print.

Returns:

(CFStringEncoding) —

true if the operation succeeds or false if the conversion fails or the provided buffer is too small.

- (`CFStringRef`) CFStringGetNameOfEncoding(encoding)

Returns the canonical name of a specified string encoding.

Parameters:

encoding (CFStringEncoding) —

The string whose attributes you want to print.

Returns:

(CFStringRef) —

A pointer to a Pascal string buffer or NULL if the internal storage of theString does not allow this to be returned efficiently.

- (`Object`) CFStringGetParagraphBounds(string, range, parBeginIndex, parEndIndex, contentsEndIndex)

Given a range of characters in a string, obtains the paragraph bounds—that is, the indexes of the first character and the final characters of the paragraph(s) containing the range.

Parameters:

string (CFStringRef) —

The string whose attributes you want to print.
range (CFRange) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
parBeginIndex (CFIndex) —

The first string to use in the comparison.
parEndIndex (CFIndex) —

The second string to use in the comparison.
contentsEndIndex (CFIndex) —

Flags that select different types of comparisons, such as localized comparison, case-insensitive comparison, and non-literal comparison. If you want the default comparison behavior, pass 0. See “String Comparison Flags” for the available flags.

Returns:

(Object) —

The range of the composed character sequence.

- (`Boolean`) CFStringGetPascalString(theString, buffer, bufferSize, encoding)

Copies the character contents of a CFString object to a local Pascal string buffer after converting the characters to a requested encoding.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
buffer (StringPtr) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
bufferSize (CFIndex) —

The first string to use in the comparison.
encoding (CFStringEncoding) —

The second string to use in the comparison.

Returns:

(Boolean) —

The string encoding that has the smallest representation of theString.

- (`ConstStringPtr`) CFStringGetPascalStringPtr(theString, encoding)

Quickly obtains a pointer to a Pascal buffer containing the characters of a string in a given encoding.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
encoding (CFStringEncoding) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(ConstStringPtr) —

true if character is mapped to a surrogate pair, otherwise false.

- (`CFRange`) CFStringGetRangeOfComposedCharactersAtIndex(theString, theIndex)

Returns the range of the composed character sequence at a specified index.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
theIndex (CFIndex) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(CFRange) —

The default string encoding.

- (`CFStringEncoding`) CFStringGetSmallestEncoding(theString)

Returns the smallest encoding on the current system for the character contents of a string.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.

Returns:

(CFStringEncoding) —

The type identifier for the CFString opaque type.

- (`Boolean`) CFStringGetSurrogatePairForLongCharacter(character, surrogates)

Maps a given UTF-32 character to a pair of UTF-16 surrogate characters.

Parameters:

character (UTF32Char) —

The string whose attributes you want to print.
surrogates (UniChar) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(Boolean) —

true if theString begins with prefix, false if otherwise.

- (`CFStringEncoding`) CFStringGetSystemEncoding

Returns the default encoding used by the operating system when it creates strings.

Returns:

(CFStringEncoding) —

true if theString ends with suffix, false otherwise.

- (`CFTypeID`) CFStringGetTypeID

Returns the type identifier for the CFString opaque type.

Returns:

(CFTypeID) —

true if the encoding is available, otherwise false.

- (`Boolean`) CFStringHasPrefix(theString, prefix)

Determines if the character data of a string begin with a specified sequence of characters.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
prefix (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(Boolean) —

true if character is a high character in a surrogate pair, otherwise false.

- (`Boolean`) CFStringHasSuffix(theString, suffix)

Determines if a string ends with a specified sequence of characters.

Parameters:

theString (CFStringRef) —

The string whose attributes you want to print.
suffix (CFStringRef) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.

Returns:

(Boolean) —

true if character is a low character in a surrogate pair, otherwise false.

- (`nil`) CFStringInitInlineBuffer(str, buf, range)

Initializes an in-line buffer to use for efficient access of a CFString object's characters.

Parameters:

str (CFStringRef) —

The string whose attributes you want to print.
buf (CFStringInlineBuffer) —

A constant C string (that is, text enclosed in double-quotation marks) from which the string is to be created.
range (CFRange) —

The first string to use in the comparison.

Returns:

(nil)

- (`nil`) CFStringInsert(str, idx, insertedStr)

Inserts a string at a specified location in the character buffer of a CFMutableString object.

Parameters:

str (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
idx (CFIndex) —

The string to append.
insertedStr (CFStringRef) —

The string to which the characters in chars are appended.

Returns:

(nil)

- (`Boolean`) CFStringIsEncodingAvailable(encoding)

Determines whether a given Core Foundation string encoding is available on the current system.

Parameters:

encoding (CFStringEncoding) —

The string whose attributes you want to print.

Returns:

(Boolean)

- (`Boolean`) CFStringIsHyphenationAvailableForLocale(locale)

Returns a Boolean value that indicates whether hyphenation data is available.

Parameters:

locale (CFLocaleRef) —

The string whose attributes you want to print.

Returns:

(Boolean)

- (`Boolean`) CFStringIsSurrogateHighCharacter(character)

Returns a Boolean value that indicates whether a given character is a high character in a surrogate pair.

Parameters:

character (UniChar) —

The string whose attributes you want to print.

Returns:

(Boolean)

- (`Boolean`) CFStringIsSurrogateLowCharacter(character)

Returns a Boolean value that indicates whether a given character is a low character in a surrogate pair.

Parameters:

character (UniChar) —

The string whose attributes you want to print.

Returns:

(Boolean)

- (`nil`) CFStringLowercase(theString, locale)

Changes all uppercase alphabetical characters in a CFMutableString to lowercase.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
locale (CFLocaleRef) —

The string to append.

Returns:

(nil)

- (`nil`) CFStringNormalize(theString, theForm)

Normalizes the string into the specified form as described in Unicode Technical Report #15.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
theForm (CFStringNormalizationForm) —

The string to append.

Returns:

(nil)

- (`nil`) CFStringPad(theString, padString, length, indexIntoPad)

Enlarges a string, padding it with specified characters, or truncates the string.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
padString (CFStringRef) —

The string to append.
length (CFIndex) —

The string to which the characters in chars are appended.
indexIntoPad (CFIndex) —

A pointer to a buffer of Unicode characters.

Returns:

(nil)

- (`nil`) CFStringReplace(theString, range, replacement)

Replaces part of the character contents of a CFMutableString object with another string.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
range (CFRange) —

The string to append.
replacement (CFStringRef) —

The string to which the characters in chars are appended.

Returns:

(nil)

- (`nil`) CFStringReplaceAll(theString, replacement)

Replaces all characters of a CFMutableString object with other characters.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
replacement (CFStringRef) —

The string to append.

Returns:

(nil)

- (`nil`) CFStringSetExternalCharactersNoCopy(theString, chars, length, capacity)

Notifies a CFMutableString object that its external backing store of Unicode characters has changed.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
chars (UniChar) —

The string to append.
length (CFIndex) —

The string to which the characters in chars are appended.
capacity (CFIndex) —

A pointer to a buffer of Unicode characters.

Returns:

(nil)

- (`CFStringTokenizerTokenType`) CFStringTokenizerAdvanceToNextToken(tokenizer)

Advances the tokenizer to the next token and sets that as the current token.

Parameters:

tokenizer (CFStringTokenizerRef) —

A CFStringTokenizer object.

Returns:

(CFStringTokenizerTokenType) —

The type of the token if the tokenizer succeeded in finding a token and setting it as current token. Returns kCFStringTokenizerTokenNone if the tokenizer failed to find a token. For possible values, see “CFStringTokenizerTokenType.”

- (`CFStringRef`) CFStringTokenizerCopyBestStringLanguage(string, range)

Guesses a language of a given string and returns the guess as a BCP 47 string.

Parameters:

string (CFStringRef) —

A CFStringTokenizer object.
range (CFRange) —

The string to test to identify the language.

Returns:

(CFStringRef) —

A language in BCP 47 form, or NULL if the language in string could not be identified. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFTypeRef`) CFStringTokenizerCopyCurrentTokenAttribute(tokenizer, attribute)

Returns a given attribute of the current token.

Parameters:

tokenizer (CFStringTokenizerRef) —

A CFStringTokenizer object.
attribute (CFOptionFlags) —

The string to test to identify the language.

Returns:

(CFTypeRef) —

The attribute specified by attribute of the current token, or NULL if the current token does not have the specified attribute or there is no current token. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFStringTokenizerRef`) CFStringTokenizerCreate(alloc, string, range, options, locale)

Returns a tokenizer for a given string.

Parameters:

alloc (CFAllocatorRef) —

A CFStringTokenizer object.
string (CFStringRef) —

The string to test to identify the language.
range (CFRange) —

The range of string to use for the test. If NULL, the first few hundred characters of the string are examined.
options (CFOptionFlags) —

A CFStringTokenizer object.
locale (CFLocaleRef) —

The token attribute to obtain. The value must be kCFStringTokenizerAttributeLatinTranscription, or kCFStringTokenizerAttributeLanguage.

Returns:

(CFStringTokenizerRef) —

A tokenizer to analyze the range range of string for the given locale and options. Ownership follows the Create Rule in Memory Management Programming Guide for Core Foundation.

- (`CFIndex`) CFStringTokenizerGetCurrentSubTokens(tokenizer, ranges, maxRangeLength, derivedSubTokens)

Retrieves the subtokens or derived subtokens contained in the compound token.

Parameters:

tokenizer (CFStringTokenizerRef) —

A CFStringTokenizer object.
ranges (CFRange) —

The string to test to identify the language.
maxRangeLength (CFIndex) —

The range of string to use for the test. If NULL, the first few hundred characters of the string are examined.
derivedSubTokens (CFMutableArrayRef) —

A CFStringTokenizer object.

Returns:

(CFIndex) —

The number of ranges returned.

- (`CFRange`) CFStringTokenizerGetCurrentTokenRange(tokenizer)

Returns the range of the current token.

Parameters:

tokenizer (CFStringTokenizerRef) —

A CFStringTokenizer object.

Returns:

(CFRange) —

The range of the current token, or 0 if there is no current token.

- (`CFTypeID`) CFStringTokenizerGetTypeID

Returns the type ID for CFStringTokenizer.

Returns:

(CFTypeID) —

The type ID for CFStringTokenizer.

- (`CFStringTokenizerTokenType`) CFStringTokenizerGoToTokenAtIndex(tokenizer, index)

Finds a token that includes the character at a given index, and set it as the current token.

Parameters:

tokenizer (CFStringTokenizerRef) —

A CFStringTokenizer object.
index (CFIndex) —

The string to test to identify the language.

Returns:

(CFStringTokenizerTokenType) —

The type of the token if the tokenizer succeeded in finding a token and setting it as the current token. Returns kCFStringTokenizerTokenNone if the tokenizer failed to find a token. For possible values, see “CFStringTokenizerTokenType.”

- (`nil`) CFStringTokenizerSetString(tokenizer, string, range)

Sets the string for a tokenizer.

Parameters:

tokenizer (CFStringTokenizerRef) —

A CFStringTokenizer object.
string (CFStringRef) —

The string to test to identify the language.
range (CFRange) —

The range of string to use for the test. If NULL, the first few hundred characters of the string are examined.

Returns:

(nil)

- (`Boolean`) CFStringTransform(string, range, transform, reverse)

Perform in-place transliteration on a mutable string.

Parameters:

string (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
range (CFRange) —

The string to append.
transform (CFStringRef) —

The string to which the characters in chars are appended.
reverse (Boolean) —

A pointer to a buffer of Unicode characters.

Returns:

(Boolean)

- (`nil`) CFStringTrim(theString, trimString)

Trims a specified substring from the beginning and end of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
trimString (CFStringRef) —

The string to append.

Returns:

(nil)

- (`nil`) CFStringTrimWhitespace(theString)

Trims whitespace from the beginning and end of a CFMutableString object.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.

Returns:

(nil)

- (`nil`) CFStringUppercase(theString, locale)

Changes all lowercase alphabetical characters in a CFMutableString object to uppercase.

Parameters:

theString (CFMutableStringRef) —

The string to which appendedString is appended. If theString is not a CFMutableString object, an assertion is raised.
locale (CFLocaleRef) —

The string to append.

Returns:

(nil)

- (`Integer`) CFSwapInt16(arg)

Swaps the bytes of a 16-bit integer.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped.

- (`Integer`) CFSwapInt16BigToHost(arg)

Converts a 16-bit integer from big-endian format to the host’s native byte order.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is big-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt16HostToBig(arg)

Converts a 16-bit integer from the host’s native byte order to big-endian format.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is big-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt16HostToLittle(arg)

Converts a 16-bit integer from the host’s native byte order to little-endian format.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is little-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt16LittleToHost(arg)

Converts a 16-bit integer from little-endian format to the host’s native byte order.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is little-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt32(arg)

Swaps the bytes of a 32-bit integer.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped.

- (`Integer`) CFSwapInt32BigToHost(arg)

Converts a 32-bit integer from big-endian format to the host’s native byte order.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is big-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt32HostToBig(arg)

Converts a 32-bit integer from the host’s native byte order to big-endian format.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is big-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt32HostToLittle(arg)

Converts a 32-bit integer from the host’s native byte order to little-endian format.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is little-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt32LittleToHost(arg)

Converts a 32-bit integer from little-endian format to the host’s native byte order.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is little-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt64(arg)

Swaps the bytes of a 64-bit integer.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped.

- (`Integer`) CFSwapInt64BigToHost(arg)

Converts a 64-bit integer from big-endian format to the host’s native byte order.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is big-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt64HostToBig(arg)

Converts a 64-bit integer from the host’s native byte order to big-endian format.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is big-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt64HostToLittle(arg)

Converts a 64-bit integer from the host’s native byte order to little-endian format.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is little-endian, this function returns arg unchanged.

- (`Integer`) CFSwapInt64LittleToHost(arg)

Converts a 64-bit integer from little-endian format to the host’s native byte order.

Parameters:

arg (Integer) —

The real value to convert.

Returns:

(Integer) —

The integer with its bytes swapped. If the host is little-endian, this function returns arg unchanged.

- (`CFStringRef`) CFTimeZoneCopyAbbreviation(tz, at)

Returns the abbreviation of a time zone at a specified date.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.
at (CFAbsoluteTime) —

The absolute time at which to obtain the abbreviation.

Returns:

(CFStringRef) —

A string containing the time zone abbreviation of at. Ownership follows the Create Rule.

- (`CFDictionaryRef`) CFTimeZoneCopyAbbreviationDictionary

Returns a dictionary holding the mappings of time zone abbreviations to time zone names.

Returns:

(CFDictionaryRef) —

A dictionary containing the mappings of time zone abbreviations to time zone names. Ownership follows the Create Rule.

- (`CFTimeZoneRef`) CFTimeZoneCopyDefault

Returns the default time zone set for your application.

Returns:

(CFTimeZoneRef) —

A time zone representing the default time zone set for your application, or the system time zone if no default is set. Ownership follows the Create Rule.

- (`CFArrayRef`) CFTimeZoneCopyKnownNames

Returns an array of strings containing the names of all the time zones known to the system.

Returns:

(CFArrayRef) —

An array containing CFString objects representing all the known time zone names. Ownership follows the Create Rule.

- (`CFStringRef`) CFTimeZoneCopyLocalizedName(tz, style, locale)

Returns the localized name of a given time zone.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.
style (CFTimeZoneNameStyle) —

The absolute time at which to obtain the abbreviation.
locale (CFLocaleRef) —

The time zone to analyze.

Returns:

(CFStringRef) —

The name of tz localized for locale. Ownership follows the Create Rule.

- (`CFTimeZoneRef`) CFTimeZoneCopySystem

Returns the time zone currently used by the system.

Returns:

(CFTimeZoneRef) —

A time zone representing the time zone currently used by the system, or the GMT time zone if the current zone cannot be determined. Ownership follows the Create Rule.

- (`CFTimeZoneRef`) CFTimeZoneCreate(allocator, name, data)

Creates a time zone with a given name and data.

Parameters:

allocator (CFAllocatorRef) —

The time zone to use.
name (CFStringRef) —

The absolute time at which to obtain the abbreviation.
data (CFDataRef) —

The time zone to analyze.

Returns:

(CFTimeZoneRef) —

A time zone corresponding to name and data. Ownership follows the Create Rule.

- (`CFTimeZoneRef`) CFTimeZoneCreateWithName(allocator, name, tryAbbrev)

Returns the time zone object identified by a given name or abbreviation.

Parameters:

allocator (CFAllocatorRef) —

The time zone to use.
name (CFStringRef) —

The absolute time at which to obtain the abbreviation.
tryAbbrev (Boolean) —

The time zone to analyze.

Returns:

(CFTimeZoneRef) —

A time zone corresponding to name, or NULL if no match was found. Ownership follows the Create Rule.

- (`CFTimeZoneRef`) CFTimeZoneCreateWithTimeIntervalFromGMT(allocator, ti)

Returns a time zone object for the specified time interval offset from Greenwich Mean Time (GMT).

Parameters:

allocator (CFAllocatorRef) —

The time zone to use.
ti (CFTimeInterval) —

The absolute time at which to obtain the abbreviation.

Returns:

(CFTimeZoneRef) —

A new time zone whose offset from GMT is given by the interval ti. The name of the new time zone is GMT +/- the offset, in hours and minutes. Time zones created with this function never have daylight savings, and the offset is constant no matter what the date. Ownership follows the Create Rule.

- (`CFDataRef`) CFTimeZoneGetData(tz)

Returns the data that stores the information used by a time zone.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.

Returns:

(CFDataRef) —

The data used to store tz. Ownership follows the Get Rule.

- (`CFTimeInterval`) CFTimeZoneGetDaylightSavingTimeOffset(tz, at)

Returns the daylight saving time offset for a time zone at a given time.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.
at (CFAbsoluteTime) —

The absolute time at which to obtain the abbreviation.

Returns:

(CFTimeInterval) —

The daylight saving time offset for tz at at.

- (`CFStringRef`) CFTimeZoneGetName(tz)

Returns the geopolitical region name that identifies a given time zone.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.

Returns:

(CFStringRef) —

A string containing the geopolitical region name that identifies tz. Ownership follows the Get Rule.

- (`CFAbsoluteTime`) CFTimeZoneGetNextDaylightSavingTimeTransition(tz, at)

Returns the time in a given time zone of the next daylight saving time transition after a given time.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.
at (CFAbsoluteTime) —

The absolute time at which to obtain the abbreviation.

Returns:

(CFAbsoluteTime) —

The time in tz of the next daylight saving time transition after at.

- (`CFTimeInterval`) CFTimeZoneGetSecondsFromGMT(tz, at)

Returns the difference in seconds between the receiver and Greenwich Mean Time (GMT) at the specified date.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.
at (CFAbsoluteTime) —

The absolute time at which to obtain the abbreviation.

Returns:

(CFTimeInterval) —

The difference in seconds between tz and GMT at the specified date, at.

- (`CFTypeID`) CFTimeZoneGetTypeID

Returns the type identifier for the CFTimeZone opaque type.

Returns:

(CFTypeID) —

The type identifier for the CFTimeZone opaque type.

- (`Boolean`) CFTimeZoneIsDaylightSavingTime(tz, at)

Returns whether or not a time zone is in daylight savings time at a specified date.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.
at (CFAbsoluteTime) —

The absolute time at which to obtain the abbreviation.

Returns:

(Boolean) —

true if tz is in daylight savings time at at, otherwise false.

- (`nil`) CFTimeZoneResetSystem

Clears the previously determined system time zone, if any.

Returns:

(nil)

- (`nil`) CFTimeZoneSetAbbreviationDictionary(dict)

Sets the abbreviation dictionary to a given dictionary.

Parameters:

dict (CFDictionaryRef) —

The time zone to use.

Returns:

(nil)

- (`nil`) CFTimeZoneSetDefault(tz)

Sets the default time zone for your application the given time zone.

Parameters:

tz (CFTimeZoneRef) —

The time zone to use.

Returns:

(nil)

- (`Object`) CFTreeAppendChild(tree, newChild)

Adds a new child to a tree as the last in its list of children.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
newChild (CFTreeRef) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(Object) —

A new CFTree object. Ownership follows the Create Rule.

- (`Object`) CFTreeApplyFunctionToChildren(tree, applier, context)

Calls a function once for each immediate child of a tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
applier (CFTreeApplierFunction) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.
context (Object) —

The tree to operate upon.

Returns:

(Object) —

The root of tree where root is defined as a tree without a parent. Ownership follows the Get Rule.

- (`CFTreeRef`) CFTreeCreate(allocator, context)

Creates a new CFTree object.

Parameters:

allocator (CFAllocatorRef) —

The tree to which to add newChild.
context (const CFTreeContext) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(CFTreeRef) —

The child tree at idx. Ownership follows the Get Rule.

- (`CFTreeRef`) CFTreeFindRoot(tree)

Returns the root tree of a given tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(CFTreeRef) —

The number of children in tree.

- (`CFTreeRef`) CFTreeGetChildAtIndex(tree, idx)

Returns the child of a tree at the specified index.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
idx (CFIndex) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(CFTreeRef) —

The first child of tree. Ownership follows the Get Rule.

- (`CFIndex`) CFTreeGetChildCount(tree)

Returns the number of children in a tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(CFIndex) —

The next sibling, adjacent to tree. Ownership follows the Get Rule.

- (`Object`) CFTreeGetChildren(tree, children)

Fills a buffer with children from the tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
children (CFTreeRef) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(Object) —

The parent of tree. Ownership follows the Get Rule.

- (`Object`) CFTreeGetContext(tree, context)

Returns the context of the specified tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
context (CFTreeContext) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(Object) —

The type identifier of the CFTree opaque type.

- (`CFTreeRef`) CFTreeGetFirstChild(tree)

Returns the first child of a tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(CFTreeRef)

- (`CFTreeRef`) CFTreeGetNextSibling(tree)

Returns the next sibling, adjacent to a given tree, in the parent's children list.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(CFTreeRef)

- (`CFTreeRef`) CFTreeGetParent(tree)

Returns the parent of a given tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(CFTreeRef)

- (`CFTypeID`) CFTreeGetTypeID

Returns the type identifier of the CFTree opaque type.

Returns:

(CFTypeID)

- (`nil`) CFTreeInsertSibling(tree, newSibling)

Inserts a new sibling after a given tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
newSibling (CFTreeRef) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFTreePrependChild(tree, newChild)

Adds a new child to the specified tree as the first in its list of children.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
newChild (CFTreeRef) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFTreeRemove(tree)

Removes a tree from its parent.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(nil)

- (`nil`) CFTreeRemoveAllChildren(tree)

Removes all the children of a tree.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.

Returns:

(nil)

- (`nil`) CFTreeSetContext(tree, context)

Replaces the context of a tree by releasing the old information pointer and retaining the new one.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
context (const CFTreeContext) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.

Returns:

(nil)

- (`nil`) CFTreeSortChildren(tree, comparator, context)

Sorts the immediate children of a tree using a specified comparator function.

Parameters:

tree (CFTreeRef) —

The tree to which to add newChild.
comparator (CFComparatorFunction) —

The child tree to add to tree. If this parameter is a tree which is already a child of any other tree, the behavior is undefined.
context (Object) —

The tree to operate upon.

Returns:

(nil)

- (`Boolean`) CFURLCanBeDecomposed(anURL)

Determines if the given URL conforms to RFC 1808 and therefore can be decomposed.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(Boolean) —

true if anURL conforms to RFC 1808, false otherwise.

- (`Object`) CFURLClearResourcePropertyCache(url)

Clears all cached resource property values of a given URL.

Parameters:

url (CFURLRef) —

The CFURL object to test.

Returns:

(Object) —

A new CFURL object, or NULL if relativeURL cannot be made absolute. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`Object`) CFURLClearResourcePropertyCacheForKey(url, key)

Discards a cached property value for a given key of a given URL.

Parameters:

url (CFURLRef) —

The CFURL object to test.
key (CFStringRef) —

The URL.

Returns:

(Object) —

The URL’s path in the format specified by pathStyle. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCopyAbsoluteURL(relativeURL)

Creates a new CFURL object by resolving the relative portion of a URL against its base.

Parameters:

relativeURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFURLRef) —

The fragment, or NULL if no fragment exists. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyFileSystemPath(anURL, pathStyle)

Returns the path portion of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.
pathStyle (CFURLPathStyle) —

The URL.

Returns:

(CFStringRef) —

The host name of anURL. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyFragment(anURL, charactersToLeaveEscaped)

Returns the fragment from a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.
charactersToLeaveEscaped (CFStringRef) —

The URL.

Returns:

(CFStringRef) —

The last path component of url. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyHostName(anURL)

Returns the host name of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The net location of anURL, or NULL if the URL cannot be decomposed (doesn’t conform to RFC 1808). Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyLastPathComponent(url)

Returns the last path component of a given URL.

Parameters:

url (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The parameter string (as defined in RFC 1738), or NULL if no parameter string exists. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyNetLocation(anURL)

Returns the net location portion of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The password, or NULL if no password exists. In some cases, this function may also return the empty string (CFSTR(“”)) if no password exists. You should consider NULL and the empty string to be equivalent. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyParameterString(anURL, charactersToLeaveEscaped)

Returns the parameter string from a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.
charactersToLeaveEscaped (CFStringRef) —

The URL.

Returns:

(CFStringRef) —

The path of anURL, or NULL if the URL cannot be decomposed (doesn’t conform to RFC 1808). Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyPassword(anURL)

Returns the password of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The path extension of url, or NULL if no extension exists. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyPath(anURL)

Returns the path portion of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The query string, or NULL if no parameter string exists. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyPathExtension(url)

Returns the path extension of a given URL.

Parameters:

url (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

A dictionary of resource property values, or NULL if an error occurs.

- (`CFStringRef`) CFURLCopyQueryString(anURL, charactersToLeaveEscaped)

Returns the query string of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.
charactersToLeaveEscaped (CFStringRef) —

The URL.

Returns:

(CFStringRef) —

true if propertyValueTypeRefPtr is successfully populated; otherwise, false.

- (`CFDictionaryRef`) CFURLCopyResourcePropertiesForKeys(url, keys, error)

Returns any number of resource property values of a URL as a dictionary.

Parameters:

url (CFURLRef) —

The CFURL object to test.
keys (CFArrayRef) —

The URL.
error (CFErrorRef) —

The URL.

Returns:

(CFDictionaryRef) —

The resource specifiers. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`Boolean`) CFURLCopyResourcePropertyForKey(url, key, propertyValueTypeRefPtr, error)

Returns the value of a given resource property of a given URL.

Parameters:

url (CFURLRef) —

The CFURL object to test.
key (CFStringRef) —

The URL.
propertyValueTypeRefPtr (Object) —

The URL.
error (CFErrorRef) —

The property value key.

Returns:

(Boolean) —

The scheme of anURL. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyResourceSpecifier(anURL)

Returns any additional resource specifiers after the path.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The path of anURL, or NULL if the URL cannot be decomposed (doesn’t conform to RFC 1808). Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyScheme(anURL)

Returns the scheme portion of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The user name, or NULL if no user name exists. In some cases, this function may also return the empty string (CFSTR(“”)) if no username exists. You should consider NULL and the empty string to be equivalent. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyStrictPath(anURL, isAbsolute)

Returns the path portion of a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.
isAbsolute (Boolean) —

The URL.

Returns:

(CFStringRef) —

A new CFURL object, or NULL if relativeURLBytes cannot be made absolute. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCopyUserName(anURL)

Returns the user name from a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

The bookmark data for the URL.

- (`CFURLRef`) CFURLCreateAbsoluteURLWithBytes(alloc, relativeURLBytes, length, encoding, baseURL, useCompatibilityMode)

Creates a new CFURL object by resolving the relative portion of a URL, specified as bytes, against its given base URL.

Parameters:

alloc (CFAllocatorRef) —

The CFURL object to test.
relativeURLBytes (const UInt8) —

The URL.
length (CFIndex) —

The URL.
encoding (CFStringEncoding) —

The property value key.
baseURL (CFURLRef) —

The CFURL object to resolve.
useCompatibilityMode (Boolean) —

The CFURL object whose path you want to obtain.

Returns:

(CFURLRef) —

The bookmark data for the file, or NULL if an error occurs.

- (`CFDataRef`) CFURLCreateBookmarkData(allocator, url, options, resourcePropertiesToInclude, relativeToURL, error)

Returns bookmark data for a URL, created with specified options and resource values.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.
options (CFURLBookmarkCreationOptions) —

The URL.
resourcePropertiesToInclude (CFArrayRef) —

The property value key.
relativeToURL (CFURLRef) —

The CFURL object to resolve.
error (CFErrorRef) —

The CFURL object whose path you want to obtain.

Returns:

(CFDataRef) —

A new URL made by resolving bookmark, or NULL if an error occurs.

- (`CFDataRef`) CFURLCreateBookmarkDataFromFile(allocator, fileURL, errorRef)

Initializes and returns bookmark data derived from a file pointed to by a specified URL.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
fileURL (CFURLRef) —

The URL.
errorRef (CFErrorRef) —

The URL.

Returns:

(CFDataRef) —

A copy of url appended with pathComponent. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateByResolvingBookmarkData(allocator, bookmark, options, relativeToURL, resourcePropertiesToInclude, isStale, error)

Returns a new URL made by resolving bookmark data.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
bookmark (CFDataRef) —

The URL.
options (CFURLBookmarkResolutionOptions) —

The URL.
relativeToURL (CFURLRef) —

The property value key.
resourcePropertiesToInclude (CFArrayRef) —

The CFURL object to resolve.
isStale (Boolean) —

The CFURL object whose path you want to obtain.
error (CFErrorRef) —

The operating system path style to be used to create the path. See “Path Style” for a list of possible values.

Returns:

(CFURLRef) —

A copy of url appended with extension. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateCopyAppendingPathComponent(allocator, url, pathComponent, isDirectory)

Creates a copy of a given URL and appends a path component.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.
pathComponent (CFStringRef) —

The URL.
isDirectory (Boolean) —

The property value key.

Returns:

(CFURLRef) —

A copy of url with the last path component deleted. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateCopyAppendingPathExtension(allocator, url, extension)

Creates a copy of a given URL and appends a path extension.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.
extension (CFStringRef) —

The URL.

Returns:

(CFURLRef) —

A copy of url with its last path extension removed. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateCopyDeletingLastPathComponent(allocator, url)

Creates a copy of a given URL with the last path component deleted.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.

Returns:

(CFURLRef) —

A new CFData object containing the content of url. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateCopyDeletingPathExtension(allocator, url)

Creates a copy of a given URL with its last path extension removed.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.

Returns:

(CFURLRef) —

A CFURL object initialized with url, or NULL if an error occurs.

- (`CFDataRef`) CFURLCreateData(allocator, url, encoding, escapeWhitespace)

Creates a CFData object containing the content of a given URL.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.
encoding (CFStringEncoding) —

The URL.
escapeWhitespace (Boolean) —

The property value key.

Returns:

(CFDataRef) —

The new file reference URL, or NULL if an error occurs.

- (`Boolean`) CFURLCreateDataAndPropertiesFromResource(alloc, url, resourceData, properties, desiredProperties, errorCode)

Loads the data and properties referred to by a given URL.

Parameters:

alloc (CFAllocatorRef) —

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 (CFURLRef) —

The URL referring to the data and/or properties you wish to load.
resourceData (CFDataRef) —

On return, contains a CFData object containing the data referred to by url. Ownership follows the Create Rule.
properties (CFDictionaryRef) —

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

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 (SInt32) —

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

Returns:

(Boolean) —

true if successful, false otherwise.

- (`CFURLRef`) CFURLCreateFilePathURL(allocator, url, error)

Initializes and returns a newly created CFURL object as a file URL with a specified path.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.
error (CFErrorRef) —

The URL.

Returns:

(CFURLRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateFileReferenceURL(allocator, url, error)

Returns a new file reference URL that points to the same resource as a specified URL.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
url (CFURLRef) —

The URL.
error (CFErrorRef) —

The URL.

Returns:

(CFURLRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateFromFileSystemRepresentation(allocator, buffer, bufLen, isDirectory)

Creates a new CFURL object for a file system entity using the native representation.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
buffer (const UInt8) —

The URL.
bufLen (CFIndex) —

The URL.
isDirectory (Boolean) —

The property value key.

Returns:

(CFURLRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateFromFileSystemRepresentationRelativeToBase(allocator, buffer, bufLen, isDirectory, baseURL)

Creates a CFURL object from a native character string path relative to a base URL.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
buffer (const UInt8) —

The URL.
bufLen (CFIndex) —

The URL.
isDirectory (Boolean) —

The property value key.
baseURL (CFURLRef) —

The CFURL object to resolve.

Returns:

(CFURLRef) —

A dictionary of the requested resource values contained in bookmarkData.

- (`CFURLRef`) CFURLCreateFromFSRef(allocator, fsRef)

Creates a URL from a given directory or file.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
fsRef (const struct FSRef) —

The URL.

Returns:

(CFURLRef) —

The resource property value.

- (`CFTypeRef`) CFURLCreatePropertyFromResource(alloc, url, property, errorCode)

Returns a given property specified by a given URL and property string.

Parameters:

alloc (CFAllocatorRef) —

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 (CFURLRef) —

The URL referring to the data and/or properties you wish to load.
property (CFStringRef) —

On return, contains a CFData object containing the data referred to by url. Ownership follows the Create Rule.
errorCode (SInt32) —

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

Returns:

(CFTypeRef) —

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

- (`CFDictionaryRef`) CFURLCreateResourcePropertiesForKeysFromBookmarkData(allocator, resourcePropertiesToReturn, bookmark)

Returns the resource values for properties identified by a specified array of keys contained in specified bookmark data.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
resourcePropertiesToReturn (CFArrayRef) —

The URL.
bookmark (CFDataRef) —

The URL.

Returns:

(CFDictionaryRef) —

A copy of originalString replacing certain characters. If it does not need to be modified (no percent escape sequences are missing), this function may merely return originalString with its reference count incremented. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFTypeRef`) CFURLCreateResourcePropertyForKeyFromBookmarkData(allocator, resourcePropertyKey, bookmark)

Returns the value of a resource property from specified bookmark data.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
resourcePropertyKey (CFStringRef) —

The URL.
bookmark (CFDataRef) —

The URL.

Returns:

(CFTypeRef) —

A new CFString object, or NULL if the percent escapes cannot be converted to characters, assuming UTF-8 encoding. If no characters need to be replaced, this function returns the original string with its reference count incremented. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCreateStringByAddingPercentEscapes(allocator, originalString, charactersToLeaveUnescaped, legalURLCharactersToBeEscaped, encoding)

Creates a copy of a string, replacing certain characters with the equivalent percent escape sequence based on the specified encoding.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
originalString (CFStringRef) —

The URL.
charactersToLeaveUnescaped (CFStringRef) —

The URL.
legalURLCharactersToBeEscaped (CFStringRef) —

The property value key.
encoding (CFStringEncoding) —

The CFURL object to resolve.

Returns:

(CFStringRef) —

A new CFString object, or NULL if the percent escapes cannot be converted to characters, assuming the encoding given by encoding. If no characters need to be replaced, this function returns the original string with its reference count incremented. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCreateStringByReplacingPercentEscapes(allocator, originalString, charactersToLeaveEscaped)

Creates a new string by replacing any percent escape sequences with their character equivalent.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
originalString (CFStringRef) —

The URL.
charactersToLeaveEscaped (CFStringRef) —

The URL.

Returns:

(CFStringRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFStringRef`) CFURLCreateStringByReplacingPercentEscapesUsingEncoding(allocator, origString, charsToLeaveEscaped, encoding)

Creates a new string by replacing any percent escape sequences with their character equivalent.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
origString (CFStringRef) —

The URL.
charsToLeaveEscaped (CFStringRef) —

The URL.
encoding (CFStringEncoding) —

The property value key.

Returns:

(CFStringRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateWithBytes(allocator, URLBytes, length, encoding, baseURL)

Creates a CFURL object using a given character bytes.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
URLBytes (const UInt8) —

The URL.
length (CFIndex) —

The URL.
encoding (CFStringEncoding) —

The property value key.
baseURL (CFURLRef) —

The CFURL object to resolve.

Returns:

(CFURLRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateWithFileSystemPath(allocator, filePath, pathStyle, isDirectory)

Creates a CFURL object using a local file system path string.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
filePath (CFStringRef) —

The URL.
pathStyle (CFURLPathStyle) —

The URL.
isDirectory (Boolean) —

The property value key.

Returns:

(CFURLRef) —

A new CFURL object. Ownership follows the create rule. See “The Create Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateWithFileSystemPathRelativeToBase(allocator, filePath, pathStyle, isDirectory, baseURL)

Creates a CFURL object using a local file system path string relative to a base URL.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
filePath (CFStringRef) —

The URL.
pathStyle (CFURLPathStyle) —

The URL.
isDirectory (Boolean) —

The property value key.
baseURL (CFURLRef) —

The CFURL object to resolve.

Returns:

(CFURLRef) —

A CFURL object representing the base URL of anURL. Ownership follows the get rule. See “The Get Rule” in Memory Management Programming Guide for Core Foundation.

- (`CFURLRef`) CFURLCreateWithString(allocator, URLString, baseURL)

Creates a CFURL object using a given CFString object.

Parameters:

allocator (CFAllocatorRef) —

The CFURL object to test.
URLString (CFStringRef) —

The URL.
baseURL (CFURLRef) —

The URL.

Returns:

(CFURLRef) —

The range of bytes for component in the buffer returned by the CFURLGetBytes function. If anURL does not contain component, the first part of the returned range is set to kCFNotFound.

- (`Boolean`) CFURLDestroyResource(url, errorCode)

Destroys a resource indicated by a given URL.

Parameters:

url (CFURLRef) —

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.
errorCode (SInt32) —

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

Returns:

(Boolean) —

true if successful, false otherwise.

- (`CFURLRef`) CFURLGetBaseURL(anURL)

Returns the base URL of a given URL if it exists.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFURLRef) —

Returns the number of bytes in buffer that were filled. If the buffer is of insufficient size, returns -1.

- (`CFRange`) CFURLGetByteRangeForComponent(url, component, rangeIncludingSeparators)

Returns the range of the specified component in the bytes of a URL.

Parameters:

url (CFURLRef) —

The CFURL object to test.
component (CFURLComponentType) —

The URL.
rangeIncludingSeparators (CFRange) —

The URL.

Returns:

(CFRange) —

true if successful, false if an error occurred.

- (`CFIndex`) CFURLGetBytes(url, buffer, bufferLength)

Returns by reference the byte representation of a URL object.

Parameters:

url (CFURLRef) —

The CFURL object to test.
buffer (UInt8) —

The URL.
bufferLength (CFIndex) —

The URL.

Returns:

(CFIndex) —

true if the conversion was successful, otherwise false.

- (`Boolean`) CFURLGetFileSystemRepresentation(url, resolveAgainstBase, buffer, maxBufLen)

Fills a buffer with the file system's native string representation of a given URL's path.

Parameters:

url (CFURLRef) —

The CFURL object to test.
resolveAgainstBase (Boolean) —

The URL.
buffer (UInt8) —

The URL.
maxBufLen (CFIndex) —

The property value key.

Returns:

(Boolean) —

The port number of anURL, or -1 if no port number exists.

- (`Boolean`) CFURLGetFSRef(url, fsRef)

Converts a given URL to a file or directory object.

Parameters:

url (CFURLRef) —

The CFURL object to test.
fsRef (struct FSRef) —

The URL.

Returns:

(Boolean) —

A string representation of anURL. Ownership follows the get rule. See “The Get Rule” in Memory Management Programming Guide for Core Foundation.

- (`SInt32`) CFURLGetPortNumber(anURL)

Returns the port number from a given URL.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(SInt32) —

The type identifier for the CFURL opaque type.

- (`CFStringRef`) CFURLGetString(anURL)

Returns the URL as a CFString object.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(CFStringRef) —

true if anURL represents a directory, false otherwise.

- (`CFTypeID`) CFURLGetTypeID

Returns the type identifier for the CFURL opaque type.

Returns:

(CFTypeID) —

true if the resource is reachable; otherwise, false.

- (`Boolean`) CFURLHasDirectoryPath(anURL)

Determines if a given URL's path represents a directory.

Parameters:

anURL (CFURLRef) —

The CFURL object to test.

Returns:

(Boolean) —

true if all resource values in keyedPropertyValues are successfully set; otherwise, false.

- (`Boolean`) CFURLResourceIsReachable(url, error)

Returns whether the resource pointed to by a file URL can be reached.

Parameters:

url (CFURLRef) —

The CFURL object to test.
error (CFErrorRef) —

The URL.

Returns:

(Boolean) —

true if the resource property named key is successfully set to value; otherwise, false.

- (`Boolean`) CFURLSetResourcePropertiesForKeys(url, keyedPropertyValues, error)

Sets resource properties of a URL specified by a given dictionary of keys and values.

Parameters:

url (CFURLRef) —

The CFURL object to test.
keyedPropertyValues (CFDictionaryRef) —

The URL.
error (CFErrorRef) —

The URL.

Returns:

(Boolean) —

true if the alias file is successfully created; otherwise, false.

- (`Boolean`) CFURLSetResourcePropertyForKey(url, key, propertyValue, error)

Sets the resource property of the URL specified by a given key to a given value.

Parameters:

url (CFURLRef) —

The CFURL object to test.
key (CFStringRef) —

The URL.
propertyValue (CFTypeRef) —

The URL.
error (CFErrorRef) —

The property value key.

Returns:

(Boolean)

- (`nil`) CFURLSetTemporaryResourcePropertyForKey(url, key, propertyValue)

Sets the resource property of the URL specified by a given key to a given value without writing the assignment to the backing store.

Parameters:

url (CFURLRef) —

The CFURL object to test.
key (CFStringRef) —

The URL.
propertyValue (CFTypeRef) —

The URL.

Returns:

(nil)

- (`Boolean`) CFURLWriteBookmarkDataToFile(bookmarkRef, fileURL, options, errorRef)

Creates an alias file on disk at a specified location with specified bookmark data.

Parameters:

bookmarkRef (CFDataRef) —

The CFURL object to test.
fileURL (CFURLRef) —

The URL.
options (CFURLBookmarkFileCreationOptions) —

The URL.
errorRef (CFErrorRef) —

The property value key.

Returns:

(Boolean)

- (`Boolean`) CFURLWriteDataAndPropertiesToResource(url, dataToWrite, propertiesToWrite, errorCode)

Writes the given data and properties to a given URL.

Parameters:

url (CFURLRef) —

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.
dataToWrite (CFDataRef) —

The URL referring to the data and/or properties you wish to load.
propertiesToWrite (CFDictionaryRef) —

On return, contains a CFData object containing the data referred to by url. Ownership follows the Create Rule.
errorCode (SInt32) —

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

Returns:

(Boolean) —

true if successful, false otherwise.

- (`CFUUIDRef`) CFUUIDCreate(alloc)

Creates a Universally Unique Identifier (UUID) object.

Parameters:

alloc (CFAllocatorRef) —

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

Returns:

(CFUUIDRef) —

A new CFUUID object. Ownership follows the Create Rule.

- (`CFUUIDRef`) CFUUIDCreateFromString(alloc, uuidStr)

Creates a CFUUID object for a specified string.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
uuidStr (CFStringRef) —

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

Returns:

(CFUUIDRef) —

A new CFUUID object, or if a CFUUID object of the same value already exists, the existing instance with its reference count incremented. Ownership follows the Create Rule.

- (`CFUUIDRef`) CFUUIDCreateFromUUIDBytes(alloc, bytes)

Creates a CFUUID object from raw UUID bytes.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
bytes (CFUUIDBytes) —

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

Returns:

(CFUUIDRef) —

A new CFUUID object. Ownership follows the Create Rule.

- (`CFStringRef`) CFUUIDCreateString(alloc, uuid)

Returns the string representation of a specified CFUUID object.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
uuid (CFUUIDRef) —

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

Returns:

(CFStringRef) —

The string representation of uuid. Ownership follows the Create Rule.

- (`CFUUIDRef`) CFUUIDCreateWithBytes(alloc, byte0, byte1, byte2, byte3, byte4, byte5, byte6, byte7, byte8, byte9, byte10, byte11, byte12, byte13, byte14, byte15)

Creates a CFUUID object from raw UUID bytes.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte0 (UInt8) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte1 (UInt8) —

A string containing a UUID. The standard format for UUIDs represented in ASCII is a string punctuated by hyphens, for example 68753A44-4D6F-1226-9C60-0050E4C00067.
byte2 (UInt8) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte3 (UInt8) —

Raw UUID bytes to use to create the CFUUID object.
byte4 (UInt8) —

The allocator to use to allocate memory for the new string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte5 (UInt8) —

The CFUUID object whose string representation to obtain.
byte6 (UInt8) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte7 (UInt8) —

Raw byte number 0.
byte8 (UInt8) —

Raw byte number 1.
byte9 (UInt8) —

Raw byte number 2.
byte10 (UInt8) —

Raw byte number 3.
byte11 (UInt8) —

Raw byte number 4.
byte12 (UInt8) —

Raw byte number 5.
byte13 (UInt8) —

Raw byte number 6.
byte14 (UInt8) —

Raw byte number 7.
byte15 (UInt8) —

Raw byte number 8.

Returns:

(CFUUIDRef) —

A new CFUUID object, or, if a CFUUID object of the same value already exists, the existing instance with its reference count incremented. Ownership follows the Create Rule.

- (`CFUUIDRef`) CFUUIDGetConstantUUIDWithBytes(alloc, byte0, byte1, byte2, byte3, byte4, byte5, byte6, byte7, byte8, byte9, byte10, byte11, byte12, byte13, byte14, byte15)

Returns a CFUUID object from raw UUID bytes.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte0 (UInt8) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte1 (UInt8) —

A string containing a UUID. The standard format for UUIDs represented in ASCII is a string punctuated by hyphens, for example 68753A44-4D6F-1226-9C60-0050E4C00067.
byte2 (UInt8) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte3 (UInt8) —

Raw UUID bytes to use to create the CFUUID object.
byte4 (UInt8) —

The allocator to use to allocate memory for the new string. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte5 (UInt8) —

The CFUUID object whose string representation to obtain.
byte6 (UInt8) —

The allocator to use to allocate memory for the new CFUUID object. Pass NULL or kCFAllocatorDefault to use the current default allocator.
byte7 (UInt8) —

Raw byte number 0.
byte8 (UInt8) —

Raw byte number 1.
byte9 (UInt8) —

Raw byte number 2.
byte10 (UInt8) —

Raw byte number 3.
byte11 (UInt8) —

Raw byte number 4.
byte12 (UInt8) —

Raw byte number 5.
byte13 (UInt8) —

Raw byte number 6.
byte14 (UInt8) —

Raw byte number 7.
byte15 (UInt8) —

Raw byte number 8.

Returns:

(CFUUIDRef) —

A CFUUID object. Ownership follows the Get Rule.

- (`CFTypeID`) CFUUIDGetTypeID

Returns the type identifier for all CFUUID objects.

Returns:

(CFTypeID) —

The type identifier for the CFUUID opaque type.

- (`CFUUIDBytes`) CFUUIDGetUUIDBytes(uuid)

Returns the value of a UUID object as raw bytes.

Parameters:

uuid (CFUUIDRef) —

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

Returns:

(CFUUIDBytes) —

The value of uuid represented as raw bytes.

- (`Boolean`) CFWriteStreamCanAcceptBytes(stream)

Returns whether a writable stream can accept new data without blocking.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.

Returns:

(Boolean) —

true if data can be written to stream without blocking, false otherwise. If stream cannot tell if data can be written without actually trying to write the data, this function returns true.

- (`Object`) CFWriteStreamClose(stream)

Closes a writable stream.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.

Returns:

(Object) —

A CFError object that describes the current problem with stream, or NULL if there is no error. Ownership follows the Create Rule.

- (`CFErrorRef`) CFWriteStreamCopyError(stream)

Returns the error associated with a stream.

Parameters:

stream (CFReadStreamRef) —

The stream to examine.

Returns:

(CFErrorRef) —

The value of the property propertyName. Ownership follows the Create Rule.

- (`CFTypeRef`) CFWriteStreamCopyProperty(stream, propertyName)

Returns the value of a property for a stream.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.
propertyName (CFStringRef) —

The stream to close.

Returns:

(CFTypeRef) —

A new write stream. Ownership follows the Create Rule.

- (`CFWriteStreamRef`) CFWriteStreamCreateWithAllocatedBuffers(alloc, bufferAllocator)

Creates a writable stream for a growable block of memory.

Parameters:

alloc (CFAllocatorRef) —

The stream to examine.
bufferAllocator (CFAllocatorRef) —

The stream to close.

Returns:

(CFWriteStreamRef) —

A new write stream, or NULL on failure. Ownership follows the Create Rule.

- (`CFWriteStreamRef`) CFWriteStreamCreateWithBuffer(alloc, buffer, bufferCapacity)

Creates a writable stream for a fixed-size block of memory.

Parameters:

alloc (CFAllocatorRef) —

The stream to examine.
buffer (UInt8) —

The stream to close.
bufferCapacity (CFIndex) —

The stream to examine.

Returns:

(CFWriteStreamRef) —

The new write stream, or NULL on failure. Ownership follows the Create Rule.

- (`CFWriteStreamRef`) CFWriteStreamCreateWithFile(alloc, fileURL)

Creates a writable stream for a file.

Parameters:

alloc (CFAllocatorRef) —

The stream to examine.
fileURL (CFURLRef) —

The stream to close.

Returns:

(CFWriteStreamRef) —

The error status of stream returned in a CFStreamError structure.

- (`CFWriteStreamRef`) CFWriteStreamCreateWithFTPURL(alloc, ftpURL)

Creates an FTP write stream.

Parameters:

alloc (CFAllocatorRef) —

The allocator to use to allocate memory for the dictionary. Pass NULL or kCFAllocatorDefault to use the current default allocator.
ftpURL (CFURLRef) —

A pointer to a buffer holding zero or more lines of resource listing.

Returns:

(CFWriteStreamRef) —

A new write stream, or NULL if the call failed. Ownership follows the Create Rule.

- (`CFStreamError`) CFWriteStreamGetError(stream)

Returns the error status of a stream. (Deprecated. Use CFWriteStreamCopyError instead.)

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.

Returns:

(CFStreamError) —

The current state of stream. See CFStreamStatus for the list of possible states.

- (`CFStreamStatus`) CFWriteStreamGetStatus(stream)

Returns the current state of a stream.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.

Returns:

(CFStreamStatus) —

The type identifier for the CFWriteStream opaque type.

- (`CFTypeID`) CFWriteStreamGetTypeID

Returns the type identifier of all CFWriteStream objects.

Returns:

(CFTypeID) —

true if stream was successfully opened, false otherwise. If stream is not in the kCFStreamStatusNotOpen state, this function returns false.

- (`Boolean`) CFWriteStreamOpen(stream)

Opens a stream for writing.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.

Returns:

(Boolean) —

true if the stream supports asynchronous notification, false otherwise.

- (`Object`) CFWriteStreamScheduleWithRunLoop(stream, runLoop, runLoopMode)

Schedules a stream into a run loop.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.
runLoop (CFRunLoopRef) —

The stream to close.
runLoopMode (CFStringRef) —

The stream to examine.

Returns:

(Object) —

true if stream recognizes and accepts the given property-value pair, false otherwise.

- (`Boolean`) CFWriteStreamSetClient(stream, streamEvents, clientCB, clientContext)

Assigns a client to a stream, which receives callbacks when certain events occur.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.
streamEvents (CFOptionFlags) —

The stream to close.
clientCB (CFWriteStreamClientCallBack) —

The stream to examine.
clientContext (CFStreamClientContext) —

The stream to examine.

Returns:

(Boolean) —

The number of bytes successfully written, 0 if the stream has been filled to capacity (for fixed-length streams), or -1 if either the stream is not open or an error occurs.

- (`Boolean`) CFWriteStreamSetProperty(stream, propertyName, propertyValue)

Sets the value of a property for a stream.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.
propertyName (CFStringRef) —

The stream to close.
propertyValue (CFTypeRef) —

The stream to examine.

Returns:

(Boolean)

- (`nil`) CFWriteStreamUnscheduleFromRunLoop(stream, runLoop, runLoopMode)

Removes a stream from a particular run loop.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.
runLoop (CFRunLoopRef) —

The stream to close.
runLoopMode (CFStringRef) —

The stream to examine.

Returns:

(nil)

- (`CFIndex`) CFWriteStreamWrite(stream, buffer, bufferLength)

Writes data to a writable stream.

Parameters:

stream (CFWriteStreamRef) —

The stream to examine.
buffer (const UInt8) —

The stream to close.
bufferLength (CFIndex) —

The stream to examine.

Returns:

(CFIndex)

- (`CGAffineTransform`) CGAffineTransformConcat(t1, t2)

Returns an affine transformation matrix constructed by combining two existing affine transforms.

Parameters:

t1 (CGAffineTransform) —

The first affine transform.
t2 (CGAffineTransform) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix. That is, t’ = t1*t2.

- (`Boolean`) CGAffineTransformEqualToTransform(t1, t2)

Checks whether two affine transforms are equal.

Parameters:

t1 (CGAffineTransform) —

The first affine transform.
t2 (CGAffineTransform) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(Boolean) —

Returns true if t1 and t2 are equal, false otherwise.

- (`CGAffineTransform`) CGAffineTransformFromString(string)

Returns a Core Graphics affine transform structure corresponding to the data in a given string.

Parameters:

string (String) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(CGAffineTransform) —

A Core Graphics affine transform structure. If the string is not well-formed, the function returns the identity transform.

- (`CGAffineTransform`) CGAffineTransformInvert(t)

Returns an affine transformation matrix constructed by inverting an existing affine transform.

Parameters:

t (CGAffineTransform) —

The first affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix. If the affine transform passed in parameter t cannot be inverted, Quartz returns the affine transform unchanged.

- (`Boolean`) CGAffineTransformIsIdentity(t)

Checks whether an affine transform is the identity transform.

Parameters:

t (CGAffineTransform) —

The first affine transform.

Returns:

(Boolean) —

Returns true if t is the identity transform, false otherwise.

- (`CGAffineTransform`) CGAffineTransformMake(a, b, c, d, tx, ty)

Returns an affine transformation matrix constructed from values you provide.

Parameters:

a (Float) —

The first affine transform.
b (Float) —

The second affine transform. This affine transform is concatenated to the first affine transform.
c (Float) —

An affine transform.
d (Float) —

An affine transform.
tx (Float) —

An existing affine transform.
ty (Float) —

The affine transform to check.

Returns:

(CGAffineTransform) —

A new affine transform matrix constructed from the values you specify.

- (`CGAffineTransform`) CGAffineTransformMakeRotation(angle)

Returns an affine transformation matrix constructed from a rotation value you provide.

Parameters:

angle (Float) —

The first affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix.

- (`CGAffineTransform`) CGAffineTransformMakeScale(sx, sy)

Returns an affine transformation matrix constructed from scaling values you provide.

Parameters:

sx (Float) —

The first affine transform.
sy (Float) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix.

- (`CGAffineTransform`) CGAffineTransformMakeTranslation(tx, ty)

Returns an affine transformation matrix constructed from translation values you provide.

Parameters:

tx (Float) —

The first affine transform.
ty (Float) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGAffineTransform) —

A new affine transform matrix.

- (`CGAffineTransform`) CGAffineTransformRotate(t, angle)

Returns an affine transformation matrix constructed by rotating an existing affine transform.

Parameters:

t (CGAffineTransform) —

The first affine transform.
angle (Float) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix.

- (`CGAffineTransform`) CGAffineTransformScale(t, sx, sy)

Returns an affine transformation matrix constructed by scaling an existing affine transform.

Parameters:

t (CGAffineTransform) —

The first affine transform.
sx (Float) —

The second affine transform. This affine transform is concatenated to the first affine transform.
sy (Float) —

An affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix.

- (`CGAffineTransform`) CGAffineTransformTranslate(t, tx, ty)

Returns an affine transformation matrix constructed by translating an existing affine transform.

Parameters:

t (CGAffineTransform) —

The first affine transform.
tx (Float) —

The second affine transform. This affine transform is concatenated to the first affine transform.
ty (Float) —

An affine transform.

Returns:

(CGAffineTransform) —

A new affine transformation matrix.

- (`CGContextRef`) CGBitmapContextCreate(data, width, height, bitsPerComponent, bytesPerRow, colorspace, bitmapInfo)

Creates a bitmap graphics context.

Parameters:

data (Object) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.
width (size_t) —

The width, in pixels, of the required bitmap.
height (size_t) —

The height, in pixels, of the required bitmap.
bitsPerComponent (size_t) —

The number of bits to use for each component of a pixel in memory. For example, for a 32-bit pixel format and an RGB color space, you would specify a value of 8 bits per component. For the list of supported pixel formats, see “Supported Pixel Formats” in the “Graphics Contexts” chapter of Quartz 2D Programming Guide.
bytesPerRow (size_t) —

The number of bytes of memory to use per row of the bitmap.
colorspace (CGColorSpaceRef) —

The color space to use for the bitmap context. Note that indexed color spaces are not supported for bitmap graphics contexts.
bitmapInfo (CGBitmapInfo) —

Constants that specify whether the bitmap should contain an alpha channel, the alpha channel’s relative location in a pixel, and information about whether the pixel components are floating-point or integer values. The constants for specifying the alpha channel information are declared with the CGImageAlphaInfo type but can be passed to this parameter safely. You can also pass the other constants associated with the CGBitmapInfo type. (See CGImage Reference for a description of the CGBitmapInfo and CGImageAlphaInfo constants.) For an example of how to specify the color space, bits per pixel, bits per pixel component, and bitmap information using the CGBitmapContextCreate function, see “Creating a Bitmap Graphics Context” in the “Graphics Contexts” chapter of Quartz 2D Programming Guide.

Returns:

(CGContextRef) —

A new bitmap context, or NULL if a context could not be created. You are responsible for releasing this object using CGContextRelease.

- (`CGImageRef`) CGBitmapContextCreateImage(c)

Creates and returns a Quartz image from the pixel data in a bitmap graphics context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(CGImageRef) —

A CGImage object that contains a snapshot of the bitmap graphics context or NULL if the image is not created.

- (`CGContextRef`) CGBitmapContextCreateWithData(data, width, height, bitsPerComponent, bytesPerRow, space, bitmapInfo, releaseCallback, releaseInfo)

Creates a bitmap graphics context with the specified callback function.

Parameters:

data (Object) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.
width (size_t) —

The width, in pixels, of the required bitmap.
height (size_t) —

The height, in pixels, of the required bitmap.
bitsPerComponent (size_t) —

The number of bits to use for each component of a pixel in memory. For example, for a 32-bit pixel format and an RGB color space, you would specify a value of 8 bits per component. For the list of supported pixel formats, see “Supported Pixel Formats” in the “Graphics Contexts” chapter of Quartz 2D Programming Guide.
bytesPerRow (size_t) —

The number of bytes of memory to use per row of the bitmap.
space (CGColorSpaceRef) —

The color space to use for the bitmap context. Note that indexed color spaces are not supported for bitmap graphics contexts.
bitmapInfo (CGBitmapInfo) —

Constants that specify whether the bitmap should contain an alpha channel, the alpha channel’s relative location in a pixel, and information about whether the pixel components are floating-point or integer values. The constants for specifying the alpha channel information are declared with the CGImageAlphaInfo type but can be passed to this parameter safely. You can also pass the other constants associated with the CGBitmapInfo type. (See CGImage Reference for a description of the CGBitmapInfo and CGImageAlphaInfo constants.) For an example of how to specify the color space, bits per pixel, bits per pixel component, and bitmap information using the CGBitmapContextCreate function, see “Creating a Bitmap Graphics Context” in the “Graphics Contexts” chapter of Quartz 2D Programming Guide.
releaseCallback (CGBitmapContextReleaseDataCallback) —

A bitmap graphics context.
releaseInfo (Object) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you do not care where the data is stored. This frees you from managing your own memory, which reduces memory leak issues. Quartz has more flexibility when it manages data storage for you. For example, it’s possible for Quartz to use OpenGL for rendering if it takes care of the memory. Do not pass NULL if you are running on earlier operating systems.

Returns:

(CGContextRef) —

A new bitmap context, or NULL if a context could not be created. You are responsible for releasing this object using CGContextRelease.

- (`CGImageAlphaInfo`) CGBitmapContextGetAlphaInfo(c)

Returns the alpha information associated with the context, which indicates how a bitmap context handles the alpha component.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(CGImageAlphaInfo) —

A bitmap information constant. If the specified context is not a bitmap context, kCGImageAlphaNone is returned. See CGImageAlphaInfo (renamed to CGBitmapInfo in OS X v10.4) for more information about values.

- (`CGBitmapInfo`) CGBitmapContextGetBitmapInfo(c)

Obtains the bitmap information associated with a bitmap graphics context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(CGBitmapInfo) —

The bitmap info of the bitmap graphics context or 0 if c is not a bitmap graphics context. See CGImage Reference for a description of the Image Bitmap Information constants that can be returned.

- (`size_t`) CGBitmapContextGetBitsPerComponent(c)

Returns the bits per component of a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(size_t) —

The number of bits per component in the specified context, or 0 if the context is not a bitmap context.

- (`size_t`) CGBitmapContextGetBitsPerPixel(c)

Returns the bits per pixel of a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(size_t) —

The number of bits per pixel in the specified context, or 0 if the context is not a bitmap context.

- (`size_t`) CGBitmapContextGetBytesPerRow(c)

Returns the bytes per row of a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(size_t) —

The number of bytes per row of the specified context, or 0 if the context is not a bitmap context.

- (`CGColorSpaceRef`) CGBitmapContextGetColorSpace(c)

Returns the color space of a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(CGColorSpaceRef) —

The color space of the specified context, or NULL if the context is not a bitmap context. You are responsible for retaining and releasing this object as necessary.

- (`Object`) CGBitmapContextGetData(c)

Returns a pointer to the image data associated with a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(Object) —

A pointer to the specified bitmap context’s image data, or NULL if the context is not a bitmap context.

- (`size_t`) CGBitmapContextGetHeight(c)

Returns the height in pixels of a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(size_t) —

The height in pixels of the specified context, or 0 if the context is not a bitmap context.

- (`size_t`) CGBitmapContextGetWidth(c)

Returns the width in pixels of a bitmap context.

Parameters:

c (CGContextRef) —

A pointer to the destination in memory where the drawing is to be rendered. The size of this memory block should be at least (bytesPerRow*height) bytes.In iOS 4.0 and later, and OS X v10.6 and later, you can pass NULL if you want Quartz to allocate memory for the bitmap. This frees you from managing your own memory, which reduces memory leak issues.

Returns:

(size_t) —

The width in pixels of the specified context, or 0 if the context is not a bitmap context.

- (`CGColorRef`) CGColorCreate(colorspace, components[])

Creates a Quartz color using a list of intensity values (including alpha) and an associated color space.

Parameters:

colorspace (CGColorSpaceRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.
components[] (const CGFloat) —

An array of intensity values describing the color. The array should contain n+1 values that correspond to the n color components in the specified color space, followed by the alpha component. Each component value should be in the range appropriate for the color space. Values outside this range will be clamped to the nearest correct value.

Returns:

(CGColorRef) —

A new Quartz color. You are responsible for releasing this object using CGColorRelease.

- (`CGColorRef`) CGColorCreateCopy(color)

Creates a copy of an existing Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(CGColorRef) —

A copy of the specified color. You are responsible for releasing this object using CGColorRelease.

- (`CGColorRef`) CGColorCreateCopyWithAlpha(color, alpha)

Creates a copy of an existing Quartz color, substituting a new alpha value.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.
alpha (Float) —

An array of intensity values describing the color. The array should contain n+1 values that correspond to the n color components in the specified color space, followed by the alpha component. Each component value should be in the range appropriate for the color space. Values outside this range will be clamped to the nearest correct value.

Returns:

(CGColorRef) —

A copy of the specified color, using the specified alpha value. You are responsible for releasing this object using CGColorRelease.

- (`CGColorRef`) CGColorCreateWithPattern(colorspace, pattern, components[])

Creates a Quartz color using a list of intensity values (including alpha), a pattern color space, and a pattern.

Parameters:

colorspace (CGColorSpaceRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.
pattern (CGPatternRef) —

An array of intensity values describing the color. The array should contain n+1 values that correspond to the n color components in the specified color space, followed by the alpha component. Each component value should be in the range appropriate for the color space. Values outside this range will be clamped to the nearest correct value.
components[] (const CGFloat) —

A Quartz color.

Returns:

(CGColorRef) —

A new Quartz color. You are responsible for releasing this object using CGColorRelease.

- (`Boolean`) CGColorEqualToColor(color1, color2)

Indicates whether two colors are equal.

Parameters:

color1 (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.
color2 (CGColorRef) —

An array of intensity values describing the color. The array should contain n+1 values that correspond to the n color components in the specified color space, followed by the alpha component. Each component value should be in the range appropriate for the color space. Values outside this range will be clamped to the nearest correct value.

Returns:

(Boolean) —

A Boolean value that, if true, indicates that the specified colors are equal. If the colors are not equal, the value is false.

- (`Float`) CGColorGetAlpha(color)

Returns the value of the alpha component associated with a Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(Float) —

An alpha intensity value in the range [0,1]. The value represents the opacity of the color.

- (`CGColorSpaceRef`) CGColorGetColorSpace(color)

Returns the color space associated with a Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(CGColorSpaceRef) —

The Quartz color space for the specified color. You are responsible for retaining and releasing it as needed.

- (`const`) CGColorGetComponents(color)

Returns the values of the color components (including alpha) associated with a Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(const) —

An array of intensity values for the color components (including alpha) associated with the specified color. The size of the array is one more than the number of components of the color space for the color.

- (`size_t`) CGColorGetNumberOfComponents(color)

Returns the number of color components (including alpha) associated with a Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(size_t) —

The number of color components (including alpha) associated with the specified color. This number is one more than the number of components of the color space for the color.

- (`CGPatternRef`) CGColorGetPattern(color)

Returns the pattern associated with a Quartz color in a pattern color space.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(CGPatternRef) —

The pattern for the specified color. You are responsible for retaining and releasing the pattern as needed.

- (`CFTypeID`) CGColorGetTypeID

Returns the Core Foundation type identifier for a Quartz color data type.

Returns:

(CFTypeID) —

The Core Foundation type identifier for CGColorRef.

- (`Object`) CGColorRelease(color)

Decrements the retain count of a Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(Object) —

The same color you passed in as the color parameter.

- (`CGColorRef`) CGColorRetain(color)

Increments the retain count of a Quartz color.

Parameters:

color (CGColorRef) —

A color space for the new color. Quartz retains this object; upon return, you may safely release it.

Returns:

(CGColorRef)

- (`CGColorSpaceRef`) CGColorSpaceCreateCalibratedGray(whitePoint[3], blackPoint[3], gamma)

Creates a calibrated grayscale color space.

Parameters:

whitePoint[3] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.
blackPoint[3] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in CIE 1931 XYZ-space, of the diffuse black point.
gamma (Float) —

The gamma value appropriate for the imaging device.

Returns:

(CGColorSpaceRef) —

A new calibrated gray color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateCalibratedRGB(whitePoint[3], blackPoint[3], gamma[3], matrix[9])

Creates a calibrated RGB color space.

Parameters:

whitePoint[3] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.
blackPoint[3] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in CIE 1931 XYZ-space, of the diffuse black point.
gamma[3] (const CGFloat) —

The gamma value appropriate for the imaging device.
matrix[9] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceRef) —

A new calibrated RGB color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateDeviceCMYK

Creates a device-dependent CMYK color space.

Returns:

(CGColorSpaceRef) —

A device-dependent CMYK color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateDeviceGray

Creates a device-dependent grayscale color space.

Returns:

(CGColorSpaceRef) —

A device-dependent gray color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateDeviceRGB

Creates a device-dependent RGB color space.

Returns:

(CGColorSpaceRef) —

A device-dependent RGB color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateICCBased(nComponents, range, profile, alternate)

Creates a device-independent color space that is defined according to the ICC color profile specification.

Parameters:

nComponents (size_t) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.
range (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in CIE 1931 XYZ-space, of the diffuse black point.
profile (Object) —

The gamma value appropriate for the imaging device.
alternate (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceRef) —

A new ICC-based color space object. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateIndexed(baseSpace, lastIndex, colorTable)

Creates an indexed color space, consisting of colors specified by a color lookup table.

Parameters:

baseSpace (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.
lastIndex (size_t) —

An array of 3 numbers specifying the tristimulus value, in CIE 1931 XYZ-space, of the diffuse black point.
colorTable (const unsigned char) —

The gamma value appropriate for the imaging device.

Returns:

(CGColorSpaceRef) —

A new indexed color space object. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateLab(whitePoint[3], blackPoint[3], range[4])

Creates a device-independent color space that is relative to human color perception, according to the CIE L*a*b* standard.

Parameters:

whitePoint[3] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.
blackPoint[3] (const CGFloat) —

An array of 3 numbers specifying the tristimulus value, in CIE 1931 XYZ-space, of the diffuse black point.
range[4] (const CGFloat) —

The gamma value appropriate for the imaging device.

Returns:

(CGColorSpaceRef) —

A new L*a*b* color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreatePattern(baseSpace)

Creates a pattern color space.

Parameters:

baseSpace (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceRef) —

A new pattern color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpaceRef`) CGColorSpaceCreateWithICCProfile(data)

Creates an ICC-based color space using the ICC profile contained in the specified data.

Parameters:

data (CFDataRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceRef) —

A new color space based on the specified profile.

- (`CGColorSpaceRef`) CGColorSpaceCreateWithName(name)

Creates a specified type of Quartz color space.

Parameters:

name (CFStringRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceRef) —

A new generic color space. You are responsible for releasing this object by calling CGColorSpaceRelease. If unsuccessful, returns NULL.

- (`CGColorSpace`) CGColorSpaceGetBaseColorSpace(space)

Returns the base color space of a pattern or indexed color space.

Parameters:

space (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpace) —

The base color space if the space parameter is a pattern or indexed color space; otherwise, NULL.

- (`Object`) CGColorSpaceGetColorTable(space, table)

Copies the entries in the color table of an indexed color space.

Parameters:

space (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.
table); (Integer) —

An array of 3 numbers specifying the tristimulus value, in CIE 1931 XYZ-space, of the diffuse black point.

Returns:

(Object) —

The number of entries in the color table of the space parameter if the color space is an indexed color space; otherwise, returns 0.

- (`size_t`) CGColorSpaceGetColorTableCount(space)

Returns the number of entries in the color table of an indexed color space.

Parameters:

space (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(size_t) —

One of the constants described in “Color Space Models”.

- (`CGColorSpaceModel`) CGColorSpaceGetModel(space)

Returns the color space model of the provided color space.

Parameters:

space (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceModel) —

The number of color components in the specified color space, not including the alpha value. For example, for an RGB color space, CGColorSpaceGetNumberOfComponents returns a value of 3.

- (`size_t`) CGColorSpaceGetNumberOfComponents(cs)

Returns the number of color components in a color space.

Parameters:

cs (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(size_t) —

The identifier for the opaque type CGColorSpaceRef.

- (`CFTypeID`) CGColorSpaceGetTypeID

Returns the Core Foundation type identifier for Quartz color spaces.

Returns:

(CFTypeID) —

The same color space you passed in as the cs parameter.

- (`nil`) CGColorSpaceRelease(cs)

Decrements the retain count of a color space.

Parameters:

cs (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(nil)

- (`CGColorSpaceRef`) CGColorSpaceRetain(cs)

Increments the retain count of a color space.

Parameters:

cs (CGColorSpaceRef) —

An array of 3 numbers specifying the tristimulus value, in the CIE 1931 XYZ-space, of the diffuse white point.

Returns:

(CGColorSpaceRef)

- (`Object`) CGContextAddArc(c, x, y, radius, startAngle, endAngle, clockwise)

Adds an arc of a circle to the current path, possibly preceded by a straight line segment

Parameters:

c (CGContextRef) —

A graphics context.
x (Float) —

The x-value, in user space coordinates, for the center of the arc.
y (Float) —

The y-value, in user space coordinates, for the center of the arc.
radius (Float) —

The radius of the arc, in user space coordinates.
startAngle (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.
endAngle (Float) —

The angle to the end point of the arc, measured in radians from the positive x-axis.
clockwise (Integer) —

Specify 1 to create a clockwise arc or 0 to create a counterclockwise arc.

Returns:

(Object) —

The coordinates of the point in device space coordinates.

- (`Object`) CGContextAddArcToPoint(c, x1, y1, x2, y2, radius)

Adds an arc of a circle to the current path, using a radius and tangent points.

Parameters:

c (CGContextRef) —

A graphics context.
x1 (Float) —

The x-value, in user space coordinates, for the center of the arc.
y1 (Float) —

The y-value, in user space coordinates, for the center of the arc.
x2 (Float) —

The radius of the arc, in user space coordinates.
y2 (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.
radius (Float) —

The angle to the end point of the arc, measured in radians from the positive x-axis.

Returns:

(Object) —

The coordinates of the point in user space coordinates.

- (`Object`) CGContextAddCurveToPoint(c, cp1x, cp1y, cp2x, cp2y, x, y)

Appends a cubic Bézier curve from the current point, using the provided control points and end point .

Parameters:

c (CGContextRef) —

A graphics context.
cp1x (Float) —

The x-value, in user space coordinates, for the center of the arc.
cp1y (Float) —

The y-value, in user space coordinates, for the center of the arc.
cp2x (Float) —

The radius of the arc, in user space coordinates.
cp2y (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.
x (Float) —

The angle to the end point of the arc, measured in radians from the positive x-axis.
y (Float) —

Specify 1 to create a clockwise arc or 0 to create a counterclockwise arc.

Returns:

(Object) —

The rectangle in device space coordinates.

- (`Object`) CGContextAddEllipseInRect(context, rect)

Adds an ellipse that fits inside the specified rectangle.

Parameters:

context (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The rectangle in user space coordinates.

- (`Object`) CGContextAddLines(c, points[], count)

Adds a sequence of connected straight-line segments to the current path.

Parameters:

c (CGContextRef) —

A graphics context.
points[] (const CGPoint) —

The x-value, in user space coordinates, for the center of the arc.
count (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The size in device space coordinates.

- (`Object`) CGContextAddLineToPoint(c, x, y)

Appends a straight line segment from the current point to the provided point .

Parameters:

c (CGContextRef) —

A graphics context.
x (Float) —

The x-value, in user space coordinates, for the center of the arc.
y (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The size in user space coordinates.

- (`Object`) CGContextAddPath(context, path)

Adds a previously created Quartz path object to the current path in a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
path (CGPathRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

A Quartz path object containing the current path data.

- (`Object`) CGContextAddQuadCurveToPoint(c, cpx, cpy, x, y)

Appends a quadratic Bézier curve from the current point, using a control point and an end point you specify.

Parameters:

c (CGContextRef) —

A graphics context.
cpx (Float) —

The x-value, in user space coordinates, for the center of the arc.
cpy (Float) —

The y-value, in user space coordinates, for the center of the arc.
x (Float) —

The radius of the arc, in user space coordinates.
y (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.

Returns:

(Object) —

The bounding box of the clipping path, specified in user space.

- (`Object`) CGContextAddRect(c, rect)

Adds a rectangular path to the current path.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The transformation matrix for the current graphics state of the specified context.

- (`Object`) CGContextAddRects(c, rects[], count)

Adds a set rectangular paths to the current path.

Parameters:

c (CGContextRef) —

A graphics context.
rects[] (const CGRect) —

The x-value, in user space coordinates, for the center of the arc.
count (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The current level of interpolation quality.

- (`Object`) CGContextBeginPage(c, mediaBox)

Starts a new page in a page-based graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
mediaBox (const CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

A CGRect value that specifies the dimensions and location, in user space, of the bounding box of the path. If there is no path, the function returns CGRectNull.

- (`Object`) CGContextBeginPath(c)

Creates a new empty path in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(Object) —

A CGPoint value that specifies the location, in user space, of current point in the context’s path. If there is no path, the function returns CGPointZero.

- (`Object`) CGContextBeginTransparencyLayer(context, auxiliaryInfo)

Begins a transparency layer.

Parameters:

context (CGContextRef) —

A graphics context.
auxiliaryInfo (CFDictionaryRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The current text matrix.

- (`Object`) CGContextBeginTransparencyLayerWithRect(context, rect, auxiliaryInfo)

Begins a transparency layer whose contents are bounded by the specified rectangle.

Parameters:

context (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.
auxiliaryInfo (CFDictionaryRef) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

Returns a CGPoint value that specifies the x and y values at which text is to be drawn, in user space coordinates.

- (`Object`) CGContextClearRect(c, rect)

Paints a transparent rectangle.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The identifier for the opaque type CGContextRef.

- (`Object`) CGContextClip(c)

Modifies the current clipping path, using the nonzero winding number rule.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(Object) —

The affine transforms that maps the user space of the graphics context to the device space.

- (`Object`) CGContextClipToMask(c, rect, mask)

Maps a mask into the specified rectangle and intersects it with the current clipping area of the graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.
mask (CGImageRef) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

Returns 1 if the context’s path contains no subpaths, otherwise returns 0.

- (`Object`) CGContextClipToRect(c, rect)

Sets the clipping path to the intersection of the current clipping path with the area defined by the specified rectangle.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

Returns true if point is inside the current path of the graphics context; false otherwise.

- (`Object`) CGContextClipToRects(c, rects[], count)

Sets the clipping path to the intersection of the current clipping path with the region defined by an array of rectangles.

Parameters:

c (CGContextRef) —

A graphics context.
rects[] (const CGRect) —

The x-value, in user space coordinates, for the center of the arc.
count (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Object) —

The same graphics context you passed in as the context parameter.

- (`nil`) CGContextClosePath(c)

Closes and terminates the current path’s subpath.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextConcatCTM(c, transform)

Transforms the user coordinate system in a context using a specified matrix.

Parameters:

c (CGContextRef) —

A graphics context.
transform (CGAffineTransform) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`CGPoint`) CGContextConvertPointToDeviceSpace(c, point)

Returns a point that is transformed from user space coordinates to device space coordinates.

Parameters:

c (CGContextRef) —

A graphics context.
point (CGPoint) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(CGPoint)

- (`CGPoint`) CGContextConvertPointToUserSpace(c, point)

Returns a point that is transformed from device space coordinates to user space coordinates.

Parameters:

c (CGContextRef) —

A graphics context.
point (CGPoint) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(CGPoint)

- (`CGRect`) CGContextConvertRectToDeviceSpace(c, rect)

Returns a rectangle that is transformed from user space coordinate to device space coordinates.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(CGRect)

- (`CGRect`) CGContextConvertRectToUserSpace(c, rect)

Returns a rectangle that is transformed from device space coordinate to user space coordinates.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(CGRect)

- (`CGSize`) CGContextConvertSizeToDeviceSpace(c, size)

Returns a size that is transformed from user space coordinates to device space coordinates.

Parameters:

c (CGContextRef) —

A graphics context.
size (CGSize) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(CGSize)

- (`CGSize`) CGContextConvertSizeToUserSpace(c, size)

Returns a size that is transformed from device space coordinates to user space coordinates

Parameters:

c (CGContextRef) —

A graphics context.
size (CGSize) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(CGSize)

- (`CGPathRef`) CGContextCopyPath(context)

Returns a Quartz path object built from the current path information in a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.

Returns:

(CGPathRef)

- (`nil`) CGContextDrawImage(c, rect, image)

Draws an image into a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.
image (CGImageRef) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`Object`) CGContextDrawLayerAtPoint(context, point, layer)

Draws the contents of a CGLayer object at the specified point.

Parameters:

context (CGContextRef) —

The graphics context associated with the layer.
point (CGPoint) —

The location, in current user space coordinates, to use as the origin for the drawing.
layer (CGLayerRef) —

The layer whose contents you want to draw.

Returns:

(Object) —

A CGLayer object. You are responsible for releasing this object using the function CGLayerRelease when you no longer need the layer.

- (`Object`) CGContextDrawLayerInRect(context, rect, layer)

Draws the contents of a CGLayer object into the specified rectangle.

Parameters:

context (CGContextRef) —

The graphics context associated with the layer.
rect (CGRect) —

The location, in current user space coordinates, to use as the origin for the drawing.
layer (CGLayerRef) —

The layer whose contents you want to draw.

Returns:

(Object) —

The graphics context associated with the layer.

- (`nil`) CGContextDrawLinearGradient(context, gradient, startPoint, endPoint, options)

Paints a gradient fill that varies along the line defined by the provided starting and ending points.

Parameters:

context (CGContextRef) —

A graphics context.
gradient (CGGradientRef) —

The x-value, in user space coordinates, for the center of the arc.
startPoint (CGPoint) —

The y-value, in user space coordinates, for the center of the arc.
endPoint (CGPoint) —

The radius of the arc, in user space coordinates.
options (CGGradientDrawingOptions) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextDrawPath(c, mode)

Draws the current path using the provided drawing mode.

Parameters:

c (CGContextRef) —

A graphics context.
mode (CGPathDrawingMode) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextDrawPDFPage(c, page)

Draws a page in the current user space of a PDF context.

Parameters:

c (CGContextRef) —

A graphics context.
page (CGPDFPageRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextDrawRadialGradient(context, gradient, startCenter, startRadius, endCenter, endRadius, options)

Paints a gradient fill that varies along the area defined by the provided starting and ending circles.

Parameters:

context (CGContextRef) —

A graphics context.
gradient (CGGradientRef) —

The x-value, in user space coordinates, for the center of the arc.
startCenter (CGPoint) —

The y-value, in user space coordinates, for the center of the arc.
startRadius (Float) —

The radius of the arc, in user space coordinates.
endCenter (CGPoint) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.
endRadius (Float) —

The angle to the end point of the arc, measured in radians from the positive x-axis.
options (CGGradientDrawingOptions) —

Specify 1 to create a clockwise arc or 0 to create a counterclockwise arc.

Returns:

(nil)

- (`nil`) CGContextDrawShading(c, shading)

Fills the clipping path of a context with the specified shading.

Parameters:

c (CGContextRef) —

A graphics context.
shading (CGShadingRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextDrawTiledImage(context, rect, image)

Repeatedly draws an image, scaled to the provided rectangle, to fill the current clip region.

Parameters:

context (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.
image (CGImageRef) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextEndPage(c)

Ends the current page in a page-based graphics context.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextEndTransparencyLayer(context)

Ends a transparency layer.

Parameters:

context (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextEOClip(c)

Modifies the current clipping path, using the even-odd rule.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextEOFillPath(c)

Paints the area within the current path, using the even-odd fill rule.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextFillEllipseInRect(context, rect)

Paints the area of the ellipse that fits inside the provided rectangle, using the fill color in the current graphics state.

Parameters:

context (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextFillPath(c)

Paints the area within the current path, using the nonzero winding number rule.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextFillRect(c, rect)

Paints the area contained within the provided rectangle, using the fill color in the current graphics state.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextFillRects(c, rects[], count)

Paints the areas contained within the provided rectangles, using the fill color in the current graphics state.

Parameters:

c (CGContextRef) —

A graphics context.
rects[] (const CGRect) —

The x-value, in user space coordinates, for the center of the arc.
count (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextFlush(c)

Forces all pending drawing operations in a window context to be rendered immediately to the destination device.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`CGRect`) CGContextGetClipBoundingBox(c)

Returns the bounding box of a clipping path.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGRect)

- (`CGAffineTransform`) CGContextGetCTM(c)

Returns the current transformation matrix.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGAffineTransform)

- (`CGInterpolationQuality`) CGContextGetInterpolationQuality(c)

Returns the current level of interpolation quality for a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGInterpolationQuality)

- (`CGRect`) CGContextGetPathBoundingBox(c)

Returns the smallest rectangle that contains the current path.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGRect)

- (`CGPoint`) CGContextGetPathCurrentPoint(c)

Returns the current point in a non-empty path.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGPoint)

- (`CGAffineTransform`) CGContextGetTextMatrix(c)

Returns the current text matrix.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGAffineTransform)

- (`CGPoint`) CGContextGetTextPosition(c)

Returns the location at which text is drawn.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGPoint)

- (`CFTypeID`) CGContextGetTypeID

Returns the type identifier for Quartz graphics contexts.

Returns:

(CFTypeID)

- (`CGAffineTransform`) CGContextGetUserSpaceToDeviceSpaceTransform(c)

Returns an affine transform that maps user space coordinates to device space coordinates.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGAffineTransform)

- (`Boolean`) CGContextIsPathEmpty(c)

Indicates whether the current path contains any subpaths.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(Boolean)

- (`nil`) CGContextMoveToPoint(c, x, y)

Begins a new subpath at the point you specify.

Parameters:

c (CGContextRef) —

A graphics context.
x (Float) —

The x-value, in user space coordinates, for the center of the arc.
y (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`Boolean`) CGContextPathContainsPoint(context, point, mode)

Checks to see whether the specified point is contained in the current path.

Parameters:

context (CGContextRef) —

A graphics context.
point (CGPoint) —

The x-value, in user space coordinates, for the center of the arc.
mode (CGPathDrawingMode) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(Boolean)

- (`nil`) CGContextRelease(c)

Decrements the retain count of a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextReplacePathWithStrokedPath(c)

Replaces the path in the graphics context with the stroked version of the path.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextRestoreGState(c)

Sets the current graphics state to the state most recently saved.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`CGContextRef`) CGContextRetain(c)

Increments the retain count of a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(CGContextRef)

- (`nil`) CGContextRotateCTM(c, angle)

Rotates the user coordinate system in a context.

Parameters:

c (CGContextRef) —

A graphics context.
angle (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSaveGState(c)

Pushes a copy of the current graphics state onto the graphics state stack for the context.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextScaleCTM(c, sx, sy)

Changes the scale of the user coordinate system in a context.

Parameters:

c (CGContextRef) —

A graphics context.
sx (Float) —

The x-value, in user space coordinates, for the center of the arc.
sy (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSelectFont(c, name, size, textEncoding)

Sets the font and font size in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
name (const char) —

The x-value, in user space coordinates, for the center of the arc.
size (Float) —

The y-value, in user space coordinates, for the center of the arc.
textEncoding (CGTextEncoding) —

The radius of the arc, in user space coordinates.

Returns:

(nil)

- (`nil`) CGContextSetAllowsAntialiasing(context, allowsAntialiasing)

Sets whether or not to allow anti-aliasing for a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
allowsAntialiasing (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetAllowsFontSmoothing(context, allowsFontSmoothing)

Sets whether or not to allow font smoothing for a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
allowsFontSmoothing (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetAllowsFontSubpixelPositioning(context, allowsFontSubpixelPositioning)

Sets whether or not to allow subpixel positioning for a graphics context

Parameters:

context (CGContextRef) —

A graphics context.
allowsFontSubpixelPositioning (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetAllowsFontSubpixelQuantization(context, allowsFontSubpixelQuantization)

Sets whether or not to allow subpixel quantization for a graphics context

Parameters:

context (CGContextRef) —

A graphics context.
allowsFontSubpixelQuantization (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetAlpha(c, alpha)

Sets the opacity level for objects drawn in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
alpha (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetBlendMode(context, mode)

Sets how Quartz composites sample values for a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
mode (CGBlendMode) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetCharacterSpacing(c, spacing)

Sets the current character spacing.

Parameters:

c (CGContextRef) —

A graphics context.
spacing (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetCMYKFillColor(c, cyan, magenta, yellow, black, alpha)

Sets the current fill color to a value in the DeviceCMYK color space.

Parameters:

c (CGContextRef) —

A graphics context.
cyan (Float) —

The x-value, in user space coordinates, for the center of the arc.
magenta (Float) —

The y-value, in user space coordinates, for the center of the arc.
yellow (Float) —

The radius of the arc, in user space coordinates.
black (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.
alpha (Float) —

The angle to the end point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextSetCMYKStrokeColor(c, cyan, magenta, yellow, black, alpha)

Sets the current stroke color to a value in the DeviceCMYK color space.

Parameters:

c (CGContextRef) —

A graphics context.
cyan (Float) —

The x-value, in user space coordinates, for the center of the arc.
magenta (Float) —

The y-value, in user space coordinates, for the center of the arc.
yellow (Float) —

The radius of the arc, in user space coordinates.
black (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.
alpha (Float) —

The angle to the end point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextSetFillColor(c, components[])

Sets the current fill color.

Parameters:

c (CGContextRef) —

A graphics context.
components[] (const CGFloat) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetFillColorSpace(c, colorspace)

Sets the fill color space in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
colorspace (CGColorSpaceRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetFillColorWithColor(c, color)

Sets the current fill color in a graphics context, using a Quartz color.

Parameters:

c (CGContextRef) —

A graphics context.
color (CGColorRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetFillPattern(c, pattern, components[])

Sets the fill pattern in the specified graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
pattern (CGPatternRef) —

The x-value, in user space coordinates, for the center of the arc.
components[] (const CGFloat) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetFlatness(c, flatness)

Sets the accuracy of curved paths in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
flatness (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetFont(c, font)

Sets the platform font in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
font (CGFontRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetFontSize(c, size)

Sets the current font size.

Parameters:

c (CGContextRef) —

A graphics context.
size (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetGrayFillColor(c, gray, alpha)

Sets the current fill color to a value in the DeviceGray color space.

Parameters:

c (CGContextRef) —

A graphics context.
gray (Float) —

The x-value, in user space coordinates, for the center of the arc.
alpha (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetGrayStrokeColor(c, gray, alpha)

Sets the current stroke color to a value in the DeviceGray color space.

Parameters:

c (CGContextRef) —

A graphics context.
gray (Float) —

The x-value, in user space coordinates, for the center of the arc.
alpha (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetInterpolationQuality(c, quality)

Sets the level of interpolation quality for a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
quality (CGInterpolationQuality) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetLineCap(c, cap)

Sets the style for the endpoints of lines drawn in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
cap (CGLineCap) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetLineDash(c, phase, lengths[], count)

Sets the pattern for dashed lines in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
phase (Float) —

The x-value, in user space coordinates, for the center of the arc.
lengths[] (const CGFloat) —

The y-value, in user space coordinates, for the center of the arc.
count (size_t) —

The radius of the arc, in user space coordinates.

Returns:

(nil)

- (`nil`) CGContextSetLineJoin(c, join)

Sets the style for the joins of connected lines in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
join (CGLineJoin) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetLineWidth(c, width)

Sets the line width for a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
width (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetMiterLimit(c, limit)

Sets the miter limit for the joins of connected lines in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
limit (Float) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetPatternPhase(c, phase)

Sets the pattern phase of a context.

Parameters:

c (CGContextRef) —

A graphics context.
phase (CGSize) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetRenderingIntent(c, intent)

Sets the rendering intent in the current graphics state.

Parameters:

c (CGContextRef) —

A graphics context.
intent (CGColorRenderingIntent) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetRGBFillColor(c, red, green, blue, alpha)

Sets the current fill color to a value in the DeviceRGB color space.

Parameters:

c (CGContextRef) —

A graphics context.
red (Float) —

The x-value, in user space coordinates, for the center of the arc.
green (Float) —

The y-value, in user space coordinates, for the center of the arc.
blue (Float) —

The radius of the arc, in user space coordinates.
alpha (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextSetRGBStrokeColor(c, red, green, blue, alpha)

Sets the current stroke color to a value in the DeviceRGB color space.

Parameters:

c (CGContextRef) —

A graphics context.
red (Float) —

The x-value, in user space coordinates, for the center of the arc.
green (Float) —

The y-value, in user space coordinates, for the center of the arc.
blue (Float) —

The radius of the arc, in user space coordinates.
alpha (Float) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextSetShadow(context, offset, blur)

Enables shadowing in a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
offset (CGSize) —

The x-value, in user space coordinates, for the center of the arc.
blur (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetShadowWithColor(context, offset, blur, color)

Enables shadowing with color a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
offset (CGSize) —

The x-value, in user space coordinates, for the center of the arc.
blur (Float) —

The y-value, in user space coordinates, for the center of the arc.
color (CGColorRef) —

The radius of the arc, in user space coordinates.

Returns:

(nil)

- (`nil`) CGContextSetShouldAntialias(c, shouldAntialias)

Sets anti-aliasing on or off for a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
shouldAntialias (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetShouldSmoothFonts(c, shouldSmoothFonts)

Enables or disables font smoothing in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
shouldSmoothFonts (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetShouldSubpixelPositionFonts(context, shouldSubpixelPositionFonts)

Enables or disables subpixel positioning in a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
shouldSubpixelPositionFonts (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetShouldSubpixelQuantizeFonts(context, shouldSubpixelQuantizeFonts)

Enables or disables subpixel quantization in a graphics context.

Parameters:

context (CGContextRef) —

A graphics context.
shouldSubpixelQuantizeFonts (Boolean) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetStrokeColor(c, components[])

Sets the current stroke color.

Parameters:

c (CGContextRef) —

A graphics context.
components[] (const CGFloat) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetStrokeColorSpace(c, colorspace)

Sets the stroke color space in a graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
colorspace (CGColorSpaceRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetStrokeColorWithColor(c, color)

Sets the current stroke color in a context, using a Quartz color.

Parameters:

c (CGContextRef) —

A graphics context.
color (CGColorRef) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetStrokePattern(c, pattern, components[])

Sets the stroke pattern in the specified graphics context.

Parameters:

c (CGContextRef) —

A graphics context.
pattern (CGPatternRef) —

The x-value, in user space coordinates, for the center of the arc.
components[] (const CGFloat) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetTextDrawingMode(c, mode)

Sets the current text drawing mode.

Parameters:

c (CGContextRef) —

A graphics context.
mode (CGTextDrawingMode) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetTextMatrix(c, t)

Sets the current text matrix.

Parameters:

c (CGContextRef) —

A graphics context.
t (CGAffineTransform) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSetTextPosition(c, x, y)

Sets the location at which text is drawn.

Parameters:

c (CGContextRef) —

A graphics context.
x (Float) —

The x-value, in user space coordinates, for the center of the arc.
y (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextShowGlyphs(c, g[], count)

Displays an array of glyphs at the current text position.

Parameters:

c (CGContextRef) —

A graphics context.
g[] (const CGGlyph) —

The x-value, in user space coordinates, for the center of the arc.
count (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextShowGlyphsAtPoint(c, x, y, glyphs[], count)

Displays an array of glyphs at a position you specify.

Parameters:

c (CGContextRef) —

A graphics context.
x (Float) —

The x-value, in user space coordinates, for the center of the arc.
y (Float) —

The y-value, in user space coordinates, for the center of the arc.
glyphs[] (const CGGlyph) —

The radius of the arc, in user space coordinates.
count (size_t) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextShowGlyphsAtPositions(context, glyphs[], positions[], count)

Draws glyphs at the provided position.

Parameters:

context (CGContextRef) —

A graphics context.
glyphs[] (const CGGlyph) —

The x-value, in user space coordinates, for the center of the arc.
positions[] (const CGPoint) —

The y-value, in user space coordinates, for the center of the arc.
count (size_t) —

The radius of the arc, in user space coordinates.

Returns:

(nil)

- (`nil`) CGContextShowGlyphsWithAdvances(c, glyphs[], advances[], count)

Draws an array of glyphs with varying offsets.

Parameters:

c (CGContextRef) —

A graphics context.
glyphs[] (const CGGlyph) —

The x-value, in user space coordinates, for the center of the arc.
advances[] (const CGSize) —

The y-value, in user space coordinates, for the center of the arc.
count (size_t) —

The radius of the arc, in user space coordinates.

Returns:

(nil)

- (`nil`) CGContextShowText(c, string, length)

Displays a character array at the current text position, a point specified by the current text matrix.

Parameters:

c (CGContextRef) —

A graphics context.
string (const char) —

The x-value, in user space coordinates, for the center of the arc.
length (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextShowTextAtPoint(c, x, y, string, length)

Displays a character string at a position you specify.

Parameters:

c (CGContextRef) —

A graphics context.
x (Float) —

The x-value, in user space coordinates, for the center of the arc.
y (Float) —

The y-value, in user space coordinates, for the center of the arc.
string (const char) —

The radius of the arc, in user space coordinates.
length (size_t) —

The angle to the starting point of the arc, measured in radians from the positive x-axis.

Returns:

(nil)

- (`nil`) CGContextStrokeEllipseInRect(context, rect)

Strokes an ellipse that fits inside the specified rectangle.

Parameters:

context (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextStrokeLineSegments(c, points[], count)

Strokes a sequence of line segments.

Parameters:

c (CGContextRef) —

A graphics context.
points[] (const CGPoint) —

The x-value, in user space coordinates, for the center of the arc.
count (size_t) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextStrokePath(c)

Paints a line along the current path.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextStrokeRect(c, rect)

Paints a rectangular path.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextStrokeRectWithWidth(c, rect, width)

Paints a rectangular path, using the specified line width.

Parameters:

c (CGContextRef) —

A graphics context.
rect (CGRect) —

The x-value, in user space coordinates, for the center of the arc.
width (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`nil`) CGContextSynchronize(c)

Marks a window context for update.

Parameters:

c (CGContextRef) —

A graphics context.

Returns:

(nil)

- (`nil`) CGContextTranslateCTM(c, tx, ty)

Changes the origin of the user coordinate system in a context.

Parameters:

c (CGContextRef) —

A graphics context.
tx (Float) —

The x-value, in user space coordinates, for the center of the arc.
ty (Float) —

The y-value, in user space coordinates, for the center of the arc.

Returns:

(nil)

- (`CGDataConsumerRef`) CGDataConsumerCreate(info, callbacks)

Creates a data consumer that uses callback functions to write data.

Parameters:

info (Object) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it passes this pointer as the info parameter.
callbacks (const CGDataConsumerCallbacks) —

A pointer to a CGDataConsumerCallbacks structure that specifies the callback functions you implement to copy data sent to the consumer and to handle the consumer’s basic memory management. For a complete description, see CGDataConsumerCallbacks.

Returns:

(CGDataConsumerRef) —

A new data consumer object. You are responsible for releasing this object using CGDataConsumerRelease.

- (`CGDataConsumerRef`) CGDataConsumerCreateWithCFData(data)

Creates a data consumer that writes to a CFData object.

Parameters:

data (CFMutableDataRef) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it passes this pointer as the info parameter.

Returns:

(CGDataConsumerRef) —

A new data consumer object. You are responsible for releasing this object using CGDataConsumerRelease.

- (`CGDataConsumerRef`) CGDataConsumerCreateWithURL(url)

Creates a data consumer that writes data to a location specified by a URL.

Parameters:

url (CFURLRef) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it passes this pointer as the info parameter.

Returns:

(CGDataConsumerRef) —

A new data consumer object. You are responsible for releasing this object using CGDataConsumerRelease.

- (`CFTypeID`) CGDataConsumerGetTypeID

Returns the Core Foundation type identifier for Quartz data consumers.

Returns:

(CFTypeID) —

The Core Foundation identifier for the opaque type CGDataConsumerRef.

- (`Object`) CGDataConsumerRelease(consumer)

Decrements the retain count of a data consumer.

Parameters:

consumer (CGDataConsumerRef) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it passes this pointer as the info parameter.

Returns:

(Object) —

The same data consumer you passed in as the consumer parameter.

- (`CGDataConsumerRef`) CGDataConsumerRetain(consumer)

Increments the retain count of a data consumer.

Parameters:

consumer (CGDataConsumerRef) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it passes this pointer as the info parameter.

Returns:

(CGDataConsumerRef)

- (`CFDataRef`) CGDataProviderCopyData(provider)

Returns a copy of the provider’s data.

Parameters:

provider (Object) —

The data provider whose data you want to copy.

Returns:

(CFDataRef) —

A new data object containing a copy of the provider’s data. You are responsible for releasing this object.

- (`Object`) CGDataProviderCreateDirect(info, size, callbacks)

Creates a Quartz direct-access data provider.

Parameters:

info (Object) —

The data provider whose data you want to copy.
size (off_t) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it sends each of the functions this pointer.
callbacks (Object) —

The number of bytes of data to provide.

Returns:

(Object) —

A new data provider. You are responsible for releasing this object using CGDataProviderRelease.

- (`Object`) CGDataProviderCreateSequential(info, callbacks)

Creates a Quartz sequential-access data provider.

Parameters:

info (Object) —

The data provider whose data you want to copy.
callbacks (Object) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it sends each of the functions this pointer.

Returns:

(Object) —

A new data provider. You are responsible for releasing this object using CGDataProviderRelease.

- (`Object`) CGDataProviderCreateWithCFData(data)

Creates a Quartz data provider that reads from a CFData object.

Parameters:

data (CFDataRef) —

The data provider whose data you want to copy.

Returns:

(Object) —

A new data provider. You are responsible for releasing this object using CGDataProviderRelease.

- (`Object`) CGDataProviderCreateWithData(info, data, size, releaseData)

Creates a Quartz direct-access data provider that uses data your program supplies.

Parameters:

info (Object) —

The data provider whose data you want to copy.
data (Object) —

A pointer to data of any type or NULL. When Quartz calls the functions specified in the callbacks parameter, it sends each of the functions this pointer.
size (size_t) —

The number of bytes of data to provide.
releaseData (Object) —

A pointer to a CGDataProviderDirectCallbacks structure that specifies the callback functions you implement to handle the data provider’s basic memory management.

Returns:

(Object) —

A new data provider. You are responsible for releasing this object using CGDataProviderRelease.

- (`Object`) CGDataProviderCreateWithFilename(filename)

Creates a Quartz direct-access data provider that uses a file to supply data.

Parameters:

filename (const char) —

The data provider whose data you want to copy.

Returns:

(Object) —

A new data provider or NULL if the file could not be opened. You are responsible for releasing this object using CGDataProviderRelease.

- (`Object`) CGDataProviderCreateWithURL(url)

Creates a Quartz direct-access data provider that uses a URL to supply data.

Parameters:

url (CFURLRef) —

The data provider whose data you want to copy.

Returns:

(Object) —

A new data provider or NULL if the data from the URL could not be accessed. You are responsible for releasing this object using CGDataProviderRelease.

- (`CFTypeID`) CGDataProviderGetTypeID

Returns the Core Foundation type identifier for Quartz data providers.

Returns:

(CFTypeID) —

The identifier for the opaque type CGDataProviderRef.

- (`Object`) CGDataProviderRelease(provider)

Decrements the retain count of a data provider.

Parameters:

provider (Object) —

The data provider whose data you want to copy.

Returns:

(Object) —

The same data provider you passed in as the provider parameter.

- (`Object`) CGDataProviderRetain(provider)

Increments the retain count of a data provider.

Parameters:

provider (Object) —

The data provider whose data you want to copy.

Returns:

(Object)

- (`Boolean`) CGFontCanCreatePostScriptSubset(font, format)

Determines whether Quartz can create a subset of the font in PostScript format.

Parameters:

font (CGFontRef) —

A font object.
format (CGFontPostScriptFormat) —

A font object.

Returns:

(Boolean) —

Returns true if a subset in the PostScript format can be created for the font; false otherwise.

- (`CFStringRef`) CGFontCopyFullName(font)

Returns the full name associated with a font object.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CFStringRef) —

The full name associated with the font.

- (`CFStringRef`) CGFontCopyGlyphNameForGlyph(font)

Returns the glyph name of the specified glyph in the specified font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CFStringRef) —

The name of the specified glyph, or NULL if the glyph isn’t associated with the font object.

- (`CFStringRef`) CGFontCopyPostScriptName(font)

Obtains the PostScript name of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CFStringRef) —

The PostScript name of the font.

- (`CFDataRef`) CGFontCopyTableForTag(font, tag)

Returns the font table that corresponds to the provided tag.

Parameters:

font (CGFontRef) —

A font object.
tag (Integer) —

A font object.

Returns:

(CFDataRef) —

The font table that corresponds to the tag, or NULL if no such table exists.

- (`CFArrayRef`) CGFontCopyTableTags(font)

Returns an array of tags that correspond to the font tables for a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CFArrayRef) —

An array of font table tags.

- (`CFArrayRef`) CGFontCopyVariationAxes(font)

Returns an array of the variation axis dictionaries for a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CFArrayRef) —

An array of the variation axis dictionaries. Returns NULL if the font doesn't support variations.

- (`CFDictionaryRef`) CGFontCopyVariations(font)

Returns the variation specification dictionary for a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CFDictionaryRef) —

The variation specification dictionary for the font. Returns NULL if the font doesn't support variations.

- (`CGFontRef`) CGFontCreateCopyWithVariations(font, variations)

Creates a copy of a font using a variation specification dictionary.

Parameters:

font (CGFontRef) —

A font object.
variations (CFDictionaryRef) —

A font object.

Returns:

(CGFontRef) —

The font object.

- (`CFDataRef`) CGFontCreatePostScriptEncoding(font, encoding[256])

Creates a PostScript encoding of a font.

Parameters:

font (CGFontRef) —

A font object.
encoding[256] (const CGGlyph) —

A font object.

Returns:

(CFDataRef) —

A PostScript encoding of the font that contains glyphs in the specified encoding.

- (`CFDataRef`) CGFontCreatePostScriptSubset(font, subsetName, format, glyphs[], count, encoding[256])

Creates a subset of the font in the specified PostScript format.

Parameters:

font (CGFontRef) —

A font object.
subsetName (CFStringRef) —

A font object.
format (CGFontPostScriptFormat) —

A font object.
glyphs[] (const CGGlyph) —

The glyph whose name is desired.
count (size_t) —

A font object.
encoding[256] (const CGGlyph) —

A font object.

Returns:

(CFDataRef) —

A subset of the font created from the supplied parameters.

- (`CGFontRef`) CGFontCreateWithDataProvider(provider)

Creates a font object from data supplied from a data provider.

Parameters:

provider (Object) —

A font object.

Returns:

(CGFontRef) —

The font object or NULL if the font can't be created. You are responsible for releasing this object using CGFontRelease.

- (`CGFontRef`) CGFontCreateWithFontName(name)

Creates a font object corresponding to the font specified by a PostScript or full name.

Parameters:

name (CFStringRef) —

A font object.

Returns:

(CGFontRef) —

The font object or NULL if the font can't be created. You are responsible for releasing this object using CGFontRelease.

- (`Integer`) CGFontGetAscent(font)

Returns the ascent of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Integer) —

The ascent of the font.

- (`Integer`) CGFontGetCapHeight(font)

Returns the cap height of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Integer) —

The cap height of the font.

- (`Integer`) CGFontGetDescent(font)

Returns the descent of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Integer) —

The descent of the font .

- (`CGRect`) CGFontGetFontBBox(font)

Returns the bounding box of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CGRect) —

The bounding box of the font.

- (`Boolean`) CGFontGetGlyphAdvances(font, glyphs[], count, advances[])

Gets the advance width of each glyph in the provided array.

Parameters:

font (CGFontRef) —

A font object.
glyphs[] (const CGGlyph) —

A font object.
count (size_t) —

A font object.
advances[] (Integer) —

The glyph whose name is desired.

Returns:

(Boolean) —

TRUE unless the advance widths can’t be provided for some reason.

- (`Boolean`) CGFontGetGlyphBBoxes(font, glyphs[], count, bboxes[])

Get the bounding box of each glyph in an array.

Parameters:

font (CGFontRef) —

A font object.
glyphs[] (const CGGlyph) —

A font object.
count (size_t) —

A font object.
bboxes[] (CGRect) —

The glyph whose name is desired.

Returns:

(Boolean) —

false if bounding boxes can't be retrieved for any reason; true otherwise.

- (`CGGlyph`) CGFontGetGlyphWithGlyphName(font)

Returns the glyph for the glyph name associated with the specified font object.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CGGlyph) —

The named glyph, or 0 if the named glyph isn’t associated with the font.

- (`Float`) CGFontGetItalicAngle(font)

Returns the italic angle of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Float) —

The italic angle of the font, measured in degrees counter-clockwise from the vertical.

- (`Integer`) CGFontGetLeading(font)

Returns the leading of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Integer) —

The leading of the font.

- (`size_t`) CGFontGetNumberOfGlyphs(font)

Returns the number of glyphs in a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(size_t) —

The number of glyphs in the provided font.

- (`Float`) CGFontGetStemV(font)

Returns the thickness of the dominant vertical stems of glyphs in a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Float) —

The thickness of the dominant vertical stems of glyphs in a font.

- (`CFTypeID`) CGFontGetTypeID

Returns the Core Foundation type identifier for Quartz fonts.

Returns:

(CFTypeID) —

The Core Foundation identifier for the opaque type CGFontRef.

- (`Integer`) CGFontGetUnitsPerEm(font)

Returns the number of glyph space units per em for the provided font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Integer) —

The number of glyph space units per em for the provided font.

- (`Integer`) CGFontGetXHeight(font)

Returns the x-height of a font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Integer) —

The x-height of the font.

- (`Object`) CGFontRelease(font)

Decrements the retain count of a Quartz font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(Object) —

The same font you specified in the font parameter.

- (`CGFontRef`) CGFontRetain(font)

Increments the retain count of a Quartz font.

Parameters:

font (CGFontRef) —

A font object.

Returns:

(CGFontRef)

- (`CGFunctionRef`) CGFunctionCreate(info, domainDimension, domain, rangeDimension, range, callbacks)

Creates a Quartz function.

Parameters:

info (Object) —

A pointer to user-defined storage for data that you want to pass to your callbacks. You need to make sure that the data persists for as long as it’s needed, which can be beyond the scope in which the Quartz function is used.
domainDimension (size_t) —

The number of inputs.
domain (const CGFloat) —

An array of (2*domainDimension) floats used to specify the valid intervals of input values. For each k from 0 to (domainDimension - 1), domain must be less than or equal to domain, and the kth input value will be clipped to lie in the interval domain ≤ input ≤ domain. If this parameter is NULL, then the input values are not clipped.
rangeDimension (size_t) —

The number of outputs.
range (const CGFloat) —

An array of (2*rangeDimension) floats that specifies the valid intervals of output values. For each k from 0 to (rangeDimension - 1), range must be less than or equal to range, and the kth output value will be clipped to lie in the interval range ≤ output ≤ range. If this parameter is NULL, then the output values are not clipped.
callbacks (const CGFunctionCallbacks) —

A pointer to a callback function table. This table should contain pointers to the callbacks you provide to implement the semantics of this Quartz function. Quartz makes a copy of your table, so, for example, you could safely pass in a pointer to a structure on the stack.

Returns:

(CGFunctionRef) —

The new Quartz function. You are responsible for releasing this object using CGFunctionRelease.

- (`CFTypeID`) CGFunctionGetTypeID

Returns the type identifier for Quartz function objects.

Returns:

(CFTypeID) —

The identifier for the opaque type CGFunctionRef.

- (`nil`) CGFunctionRelease(function)

Decrements the retain count of a function object.

Parameters:

function (CGFunctionRef) —

A pointer to user-defined storage for data that you want to pass to your callbacks. You need to make sure that the data persists for as long as it’s needed, which can be beyond the scope in which the Quartz function is used.

Returns:

(nil)

- (`CGFunctionRef`) CGFunctionRetain(function)

Increments the retain count of a function object.

Parameters:

function (CGFunctionRef) —

A pointer to user-defined storage for data that you want to pass to your callbacks. You need to make sure that the data persists for as long as it’s needed, which can be beyond the scope in which the Quartz function is used.

Returns:

(CGFunctionRef)

- (`CGGradientRef`) CGGradientCreateWithColorComponents(space, components[], locations[], count)

Creates a CGGradient object from a color space and the provided color components and locations.

Parameters:

space (CGColorSpaceRef) —

The color space to use for the gradient. You cannot use a pattern or indexed color space.
components[] (const CGFloat) —

The color components for each color that defines the gradient. The components should be in the color space specified by space. If you are unsure of the number of components, you can call the function CGColorSpaceGetNumberOfComponents.The number of items in this array should be the product of count and the number of components in the color space. For example, if the color space is an RGBA color space and you want to use two colors in the gradient (one for a starting location and another for an ending location), then you need to provide 8 values in components—red, green, blue, and alpha values for the first color, followed by red, green, blue, and alpha values for the second color.
locations[] (const CGFloat) —

The location for each color provided in components. Each location must be a CGFloat value in the range of 0 to 1, inclusive. If 0 and 1 are not in the locations array, Quartz uses the colors provided that are closest to 0 and 1 for those locations. If locations is NULL, the first color in colors is assigned to location 0, the last color incolors is assigned to location 1, and intervening colors are assigned locations that are at equal intervals in between.
count (size_t) —

The number of locations provided in the locations parameters.

Returns:

(CGGradientRef) —

A CGGradient object.

- (`CGGradientRef`) CGGradientCreateWithColors(space, colors, locations[])

Creates a CGGradient object from a color space and the provided color objects and locations.

Parameters:

space (CGColorSpaceRef) —

The color space to use for the gradient. You cannot use a pattern or indexed color space.
colors (CFArrayRef) —

The color components for each color that defines the gradient. The components should be in the color space specified by space. If you are unsure of the number of components, you can call the function CGColorSpaceGetNumberOfComponents.The number of items in this array should be the product of count and the number of components in the color space. For example, if the color space is an RGBA color space and you want to use two colors in the gradient (one for a starting location and another for an ending location), then you need to provide 8 values in components—red, green, blue, and alpha values for the first color, followed by red, green, blue, and alpha values for the second color.
locations[] (const CGFloat) —

The location for each color provided in components. Each location must be a CGFloat value in the range of 0 to 1, inclusive. If 0 and 1 are not in the locations array, Quartz uses the colors provided that are closest to 0 and 1 for those locations. If locations is NULL, the first color in colors is assigned to location 0, the last color incolors is assigned to location 1, and intervening colors are assigned locations that are at equal intervals in between.

Returns:

(CGGradientRef) —

A CGGradient object.

- (`CFTypeID`) CGGradientGetTypeID

Returns the Core Foundation type identifier for CGGradient objects.

Returns:

(CFTypeID) —

The Core Foundation identifier for the opaque type CGGradientRef.

- (`Object`) CGGradientRelease(gradient)

Decrements the retain count of a CGGradient object.

Parameters:

gradient (CGGradientRef) —

The color space to use for the gradient. You cannot use a pattern or indexed color space.

Returns:

(Object) —

The same gradient object that you passed in as the gradient parameter.

- (`CGGradientRef`) CGGradientRetain(gradient)

Increments the retain count of a CGGradient object.

Parameters:

gradient (CGGradientRef) —

The color space to use for the gradient. You cannot use a pattern or indexed color space.

Returns:

(CGGradientRef)

- (`CGImageRef`) CGImageCreate(width, height, bitsPerComponent, bitsPerPixel, bytesPerRow, colorspace, bitmapInfo, provider, decode[], shouldInterpolate, intent)

Creates a bitmap image from data supplied by a data provider.

Parameters:

width (size_t) —

The width, in pixels, of the required image.
height (size_t) —

The height, in pixels, of the required image
bitsPerComponent (size_t) —

The number of bits for each component in a source pixel. For example, if the source image uses the RGBA-32 format, you would specify 8 bits per component.
bitsPerPixel (size_t) —

The total number of bits in a source pixel. This value must be at least bitsPerComponent times the number of components per pixel.
bytesPerRow (size_t) —

The number of bytes of memory for each horizontal row of the bitmap.
colorspace (CGColorSpaceRef) —

The color space for the image. Quartz retains the color space you pass in; on return, you may safely release it.
bitmapInfo (CGBitmapInfo) —

A CGBitmapInfo constant that specifies whether the bitmap should contain an alpha channel and its relative location in a pixel, along with whether the components are floating-point or integer values.
provider (Object) —

The source of data for the bitmap. For information about supported data formats, see the discussion below. Quartz retains this object; on return, you may safely release it.
decode[] (const CGFloat) —

The decode array for the image. If you do not want to allow remapping of the image’s color values, pass NULL for the decode array. For each color component in the image’s color space (including the alpha component), a decode array provides a pair of values denoting the upper and lower limits of a range. For example, the decode array for a source image in the RGB color space would contain six entries total, consisting of one pair each for red, green, and blue. When the image is rendered, Quartz uses a linear transform to map the original component value into a relative number within your designated range that is appropriate for the destination color space.
shouldInterpolate (Boolean) —

A Boolean value that specifies whether interpolation should occur. The interpolation setting specifies whether Quartz should apply a pixel-smoothing algorithm to the image. Without interpolation, the image may appear jagged or pixelated when drawn on an output device with higher resolution than the image data.
intent (CGColorRenderingIntent) —

A rendering intent constant that specifies how Quartz should handle colors that are not located within the gamut of the destination color space of a graphics context. The rendering intent determines the exact method used to map colors from one color space to another. For descriptions of the defined rendering-intent constants, see Color Rendering Intents.

Returns:

(CGImageRef) —

A new Quartz bitmap image. You are responsible for releasing this object by calling CGImageRelease.

- (`CGImageRef`) CGImageCreateCopy(image)

Creates a copy of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(CGImageRef) —

An copy of the image specified by the image parameter.

- (`CGImageRef`) CGImageCreateCopyWithColorSpace(image, colorspace)

Create a copy of a bitmap image, replacing its colorspace.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.
colorspace (CGColorSpaceRef) —

The height, in pixels, of the required image

Returns:

(CGImageRef) —

A new Quartz image that is a copy of the image passed as the image parameter but with its color space replaced by that specified by the colorspace parameter. Returns NULL if image is an image mask, or if the number of components of colorspace is not the same as the number of components of the colorspace of image. You are responsible for releasing this object using CGImageRelease.

- (`CGImageRef`) CGImageCreateWithImageInRect(image, rect)

Creates a bitmap image using the data contained within a subregion of an existing bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.
rect (CGRect) —

The height, in pixels, of the required image

Returns:

(CGImageRef) —

A CGImage object that specifies a subimage of the image. If the rect parameter defines an area that is not in the image, returns NULL.

- (`CGImageRef`) CGImageCreateWithJPEGDataProvider(source, decode[], shouldInterpolate, intent)

Creates a bitmap image using JPEG-encoded data supplied by a data provider.

Parameters:

source (Object) —

The width, in pixels, of the required image.
decode[] (const CGFloat) —

The height, in pixels, of the required image
shouldInterpolate (Boolean) —

The number of bits for each component in a source pixel. For example, if the source image uses the RGBA-32 format, you would specify 8 bits per component.
intent (CGColorRenderingIntent) —

The total number of bits in a source pixel. This value must be at least bitsPerComponent times the number of components per pixel.

Returns:

(CGImageRef) —

A new Quartz bitmap image. You are responsible for releasing this object by calling CGImageRelease.

- (`CGImageRef`) CGImageCreateWithMask(image, mask)

Creates a bitmap image from an existing image and an image mask.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.
mask (CGImageRef) —

The height, in pixels, of the required image

Returns:

(CGImageRef) —

An image created by masking image with mask. You are responsible for releasing this object by calling CGImageRelease.

- (`CGImageRef`) CGImageCreateWithMaskingColors(image, components[])

Creates a bitmap image by masking an existing bitmap image with the provided color values.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.
components[] (const CGFloat) —

The height, in pixels, of the required image

Returns:

(CGImageRef) —

An image created by masking image with the colors specified in the components array. You are responsible for releasing this object by calling CGImageRelease.

- (`CGImageRef`) CGImageCreateWithPNGDataProvider(source, decode[], shouldInterpolate, intent)

Creates a Quartz bitmap image using PNG-encoded data supplied by a data provider.

Parameters:

source (Object) —

The width, in pixels, of the required image.
decode[] (const CGFloat) —

The height, in pixels, of the required image
shouldInterpolate (Boolean) —

The number of bits for each component in a source pixel. For example, if the source image uses the RGBA-32 format, you would specify 8 bits per component.
intent (CGColorRenderingIntent) —

The total number of bits in a source pixel. This value must be at least bitsPerComponent times the number of components per pixel.

Returns:

(CGImageRef) —

A new Quartz bitmap image. You are responsible for releasing this object by calling CGImageRelease.

- (`Object`) CGImageDestinationAddImage(idst, image, properties)

Adds an image to an image destination.

Parameters:

idst (CGImageDestinationRef) —

An image destination
image (CGImageRef) —

The image to add.
properties (CFDictionaryRef) —

An optional dictionary that specifies the properties of the added image. The dictionary can contain any of the properties described in “Destination Properties” or the image properties described in CGImageProperties Reference.

Returns:

(Object) —

Returns an array of the UTIs that are supported for image destinations. See Uniform Type Identifiers Overview for a list of system-declared and third-party UTIs that can be returned.

- (`Object`) CGImageDestinationAddImageFromSource(idst, isrc, index, properties)

Adds an image from an image source to an image destination.

Parameters:

idst (CGImageDestinationRef) —

An image destination
isrc (CGImageSourceRef) —

The image to add.
index (size_t) —

An optional dictionary that specifies the properties of the added image. The dictionary can contain any of the properties described in “Destination Properties” or the image properties described in CGImageProperties Reference.
properties (CFDictionaryRef) —

An image destination.

Returns:

(Object) —

An image destination. You are responsible for releasing this object using CFRelease.

- (`CFArrayRef`) CGImageDestinationCopyTypeIdentifiers

Returns an array of the uniform type identifiers (UTIs) that are supported for image destinations.

Returns:

(CFArrayRef) —

An image destination. You are responsible for releasing this object using CFRelease.

- (`CGImageDestinationRef`) CGImageDestinationCreateWithData(data, type, count, options)

Creates an image destination that writes to a Core Foundation mutable data object.

Parameters:

data (CFMutableDataRef) —

An image destination
type (CFStringRef) —

The image to add.
count (size_t) —

An optional dictionary that specifies the properties of the added image. The dictionary can contain any of the properties described in “Destination Properties” or the image properties described in CGImageProperties Reference.
options (CFDictionaryRef) —

An image destination.

Returns:

(CGImageDestinationRef) —

An image destination. You are responsible for releasing this object using CFRelease.

- (`CGImageDestinationRef`) CGImageDestinationCreateWithDataConsumer(consumer, type, count, options)

Creates an image destination that writes to the specified data consumer.

Parameters:

consumer (CGDataConsumerRef) —

An image destination
type (CFStringRef) —

The image to add.
count (size_t) —

An optional dictionary that specifies the properties of the added image. The dictionary can contain any of the properties described in “Destination Properties” or the image properties described in CGImageProperties Reference.
options (CFDictionaryRef) —

An image destination.

Returns:

(CGImageDestinationRef) —

Returns true if the image is successfully written; false otherwise.

- (`CGImageDestinationRef`) CGImageDestinationCreateWithURL(url, type, count, options)

Creates an image destination that writes to a location specified by a URL.

Parameters:

url (CFURLRef) —

An image destination
type (CFStringRef) —

The image to add.
count (size_t) —

An optional dictionary that specifies the properties of the added image. The dictionary can contain any of the properties described in “Destination Properties” or the image properties described in CGImageProperties Reference.
options (CFDictionaryRef) —

An image destination.

Returns:

(CGImageDestinationRef) —

Returns the Core Foundation type ID for an image destination.

- (`Boolean`) CGImageDestinationFinalize(idst)

Writes image data and properties to the data, URL, or data consumer associated with the image destination.

Parameters:

idst (CGImageDestinationRef) —

An image destination

Returns:

(Boolean)

- (`CFTypeID`) CGImageDestinationGetTypeID

Returns the unique type identifier of an image destination opaque type.

Returns:

(CFTypeID)

- (`nil`) CGImageDestinationSetProperties(idst, properties)

Applies one or more properties to all images in an image destination.

Parameters:

idst (CGImageDestinationRef) —

An image destination
properties (CFDictionaryRef) —

The image to add.

Returns:

(nil)

- (`CGImageAlphaInfo`) CGImageGetAlphaInfo(image)

Returns the alpha channel information for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(CGImageAlphaInfo) —

A CGImageAlphaInfo constant that specifies (1) whether the bitmap contains an alpha channel, (2) where the alpha bits are located in the image data, and (3) whether the alpha value is premultiplied. For possible values, see “Constants.” The function returns kCGImageAlphaNone if the image parameter refers to an image mask.

- (`CGBitmapInfo`) CGImageGetBitmapInfo(image)

Returns the bitmap information for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(CGBitmapInfo) —

The bitmap information associated with an image.

- (`size_t`) CGImageGetBitsPerComponent(image)

Returns the number of bits allocated for a single color component of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(size_t) —

The number of bits used in memory for each color component of the specified bitmap image (or image mask). Possible values are 1, 2, 4, or 8. For example, for a 16-bit RGB(A) colorspace, the function would return a value of 4 bits per color component.

- (`size_t`) CGImageGetBitsPerPixel(image)

Returns the number of bits allocated for a single pixel in a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(size_t) —

The number of bits used in memory for each pixel of the specified bitmap image (or image mask).

- (`size_t`) CGImageGetBytesPerRow(image)

Returns the number of bytes allocated for a single row of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(size_t) —

The number of bytes used in memory for each row of the specified bitmap image (or image mask).

- (`CGColorSpaceRef`) CGImageGetColorSpace(image)

Return the color space for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(CGColorSpaceRef) —

The source color space for the specified bitmap image, or NULL if the image is an image mask. You are responsible for retaining and releasing the color space as necessary.

- (`Object`) CGImageGetDataProvider(image)

Returns the data provider for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(Object) —

The data provider for the specified bitmap image (or image mask). You are responsible for retaining and releasing the data provider as necessary.

- (`const`) CGImageGetDecode(image)

Returns the decode array for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(const) —

The decode array for a bitmap image (or image mask). See the discussion for a description of possible return values.

- (`size_t`) CGImageGetHeight(image)

Returns the height of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(size_t) —

The height in pixels of the bitmap image (or image mask).

- (`CGColorRenderingIntent`) CGImageGetRenderingIntent(image)

Returns the rendering intent setting for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(CGColorRenderingIntent) —

Returns the CGColorRenderingIntent constant that specifies how Quartz should handle colors that are not located within the gamut of the destination color space of a graphics context in which the image is drawn. If the image is an image mask, this function returns kCGRenderingIntentDefault.

- (`Boolean`) CGImageGetShouldInterpolate(image)

Returns the interpolation setting for a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(Boolean) —

Returns 1 if interpolation is enabled for the specified bitmap image (or image mask), otherwise, returns 0.

- (`CFTypeID`) CGImageGetTypeID

Returns the type identifier for Quartz bitmap images.

Returns:

(CFTypeID) —

The identifier for the opaque type CGImageRef.

- (`size_t`) CGImageGetWidth(image)

Returns the width of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(size_t) —

The width, in pixels, of the specified bitmap image (or image mask).

- (`Boolean`) CGImageIsMask(image)

Returns whether a bitmap image is an image mask.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(Boolean) —

A Boolean value that indicates whether the image passed in the image parameter is an image mask (true indicates that the image is an image mask).

- (`CGImageRef`) CGImageMaskCreate(width, height, bitsPerComponent, bitsPerPixel, bytesPerRow, provider, decode[], shouldInterpolate)

Creates a bitmap image mask from data supplied by a data provider.

Parameters:

width (size_t) —

The width, in pixels, of the required image.
height (size_t) —

The height, in pixels, of the required image
bitsPerComponent (size_t) —

The number of bits for each component in a source pixel. For example, if the source image uses the RGBA-32 format, you would specify 8 bits per component.
bitsPerPixel (size_t) —

The total number of bits in a source pixel. This value must be at least bitsPerComponent times the number of components per pixel.
bytesPerRow (size_t) —

The number of bytes of memory for each horizontal row of the bitmap.
provider (Object) —

The color space for the image. Quartz retains the color space you pass in; on return, you may safely release it.
decode[] (const CGFloat) —

A CGBitmapInfo constant that specifies whether the bitmap should contain an alpha channel and its relative location in a pixel, along with whether the components are floating-point or integer values.
shouldInterpolate (Boolean) —

The source of data for the bitmap. For information about supported data formats, see the discussion below. Quartz retains this object; on return, you may safely release it.

Returns:

(CGImageRef) —

A Quartz bitmap image mask. You are responsible for releasing this object by calling CGImageRelease.

- (`Object`) CGImageRelease(image)

Decrements the retain count of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(Object) —

The same image you passed in as the image parameter.

- (`CGImageRef`) CGImageRetain(image)

Increments the retain count of a bitmap image.

Parameters:

image (CGImageRef) —

The width, in pixels, of the required image.

Returns:

(CGImageRef)

- (`CFDictionaryRef`) CGImageSourceCopyProperties(isrc, options)

Returns the properties of the image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.
options (CFDictionaryRef) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.

Returns:

(CFDictionaryRef) —

A dictionary that contains the properties associated with the image source container. See CGImageProperties Reference for a list of properties that can be in the dictionary.

- (`CFDictionaryRef`) CGImageSourceCopyPropertiesAtIndex(isrc, index, options)

Returns the properties of the image at a specified location in an image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.
index (size_t) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.
options (CFDictionaryRef) —

An image source.

Returns:

(CFDictionaryRef) —

A dictionary that contains the properties associated with the image. See CGImageProperties Reference for a list of properties that can be in the dictionary.

- (`CFArrayRef`) CGImageSourceCopyTypeIdentifiers

Returns an array of uniform type identifiers (UTIs) that are supported for image sources.

Returns:

(CFArrayRef) —

Returns an array of the UTIs that are supported for image sources.

- (`CGImageRef`) CGImageSourceCreateImageAtIndex(isrc, index, options)

Creates a CGImage object for the image data associated with the specified index in an image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.
index (size_t) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.
options (CFDictionaryRef) —

An image source.

Returns:

(CGImageRef) —

Returns a CGImage object. You are responsible for releasing this object using CGImageRelease.

- (`CGImageSourceRef`) CGImageSourceCreateIncremental(options)

Create an incremental image source.

Parameters:

options (CFDictionaryRef) —

An image source.

Returns:

(CGImageSourceRef) —

Returns an image source object. You are responsible for releasing this object using CFRelease.

- (`CGImageRef`) CGImageSourceCreateThumbnailAtIndex(isrc, index, options)

Creates a thumbnail image of the image located at a specified location in an image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.
index (size_t) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.
options (CFDictionaryRef) —

An image source.

Returns:

(CGImageRef) —

A CGImage object. You are responsible for releasing this object using CGImageRelease.

- (`CGImageSourceRef`) CGImageSourceCreateWithData(data, options)

Creates an image source that reads from a Core Foundation data object.

Parameters:

data (CFDataRef) —

An image source.
options (CFDictionaryRef) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.

Returns:

(CGImageSourceRef) —

An image source. You are responsible for releasing this object using CFRelease.

- (`CGImageSourceRef`) CGImageSourceCreateWithDataProvider(provider, options)

Creates an image source that reads data from the specified data provider.

Parameters:

provider (Object) —

An image source.
options (CFDictionaryRef) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.

Returns:

(CGImageSourceRef) —

An image source. You are responsible for releasing this object using CFRelease.

- (`CGImageSourceRef`) CGImageSourceCreateWithURL(url, options)

Creates an image source that reads from a location specified by a URL.

Parameters:

url (CFURLRef) —

An image source.
options (CFDictionaryRef) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.

Returns:

(CGImageSourceRef) —

An image source. You are responsible for releasing this object using CFRelease.

- (`size_t`) CGImageSourceGetCount(isrc)

Returns the number of images (not including thumbnails) in the image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.

Returns:

(size_t) —

The number of images. If the image source is a multilayered PSD file, the function returns 1.

- (`CGImageSourceStatus`) CGImageSourceGetStatus(isrc)

Return the status of an image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.

Returns:

(CGImageSourceStatus) —

Returns the current status of the image source. See “Image Source Status” for a list of possible values.

- (`CGImageSourceStatus`) CGImageSourceGetStatusAtIndex(isrc, index)

Returns the current status of an image that is at a specified location in an image source.

Parameters:

isrc (CGImageSourceRef) —

An image source.
index (size_t) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.

Returns:

(CGImageSourceStatus) —

Returns the current status of the image. See “Image Source Status” for a list of possible values.

- (`CFStringRef`) CGImageSourceGetType(isrc)

Returns the uniform type identifier of the source container.

Parameters:

isrc (CGImageSourceRef) —

An image source.

Returns:

(CFStringRef) —

The uniform type identifier of the image.

- (`CFTypeID`) CGImageSourceGetTypeID

Returns the unique type identifier of an image source opaque type.

Returns:

(CFTypeID) —

Returns the Core Foundation type ID for an image source.

- (`nil`) CGImageSourceUpdateData(isrc, data, final)

Updates an incremental image source with new data.

Parameters:

isrc (CGImageSourceRef) —

An image source.
data (CFDataRef) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.
final (Boolean) —

An image source.

Returns:

(nil)

- (`nil`) CGImageSourceUpdateDataProvider(isrc, provider, final)

Updates an incremental image source with a new data provider.

Parameters:

isrc (CGImageSourceRef) —

An image source.
provider (Object) —

A dictionary you can use to request additional options. See “Image Source Option Dictionary Keys” for the keys you can supply.
final (Boolean) —

An image source.

Returns:

(nil)

- (`CGLayerRef`) CGLayerCreateWithContext(context, size, auxiliaryInfo)

Creates a CGLayer object that is associated with a graphics context.

Parameters:

context (CGContextRef) —

The graphics context associated with the layer.
size (CGSize) —

The location, in current user space coordinates, to use as the origin for the drawing.
auxiliaryInfo (CFDictionaryRef) —

The layer whose contents you want to draw.

Returns:

(CGLayerRef) —

The width and height of the layer, in default user space coordinates.

- (`CGContextRef`) CGLayerGetContext(layer)

Returns the graphics context associated with a CGLayer object.

Parameters:

layer (CGLayerRef) —

The graphics context associated with the layer.

Returns:

(CGContextRef) —

The type identifier for CGLayer objects.

- (`CGSize`) CGLayerGetSize(layer)

Returns the width and height of a CGLayer object.

Parameters:

layer (CGLayerRef) —

The graphics context associated with the layer.

Returns:

(CGSize) —

The same layer you passed in as the layer parameter.

- (`CFTypeID`) CGLayerGetTypeID

Returns the unique type identifier used for CGLayer objects.

Returns:

(CFTypeID)

- (`nil`) CGLayerRelease(layer)

Decrements the retain count of a CGLayer object.

Parameters:

layer (CGLayerRef) —

The graphics context associated with the layer.

Returns:

(nil)

- (`CGLayerRef`) CGLayerRetain(layer)

Increments the retain count of a CGLayer object.

Parameters:

layer (CGLayerRef) —

The graphics context associated with the layer.

Returns:

(CGLayerRef)

- (`Object`) CGPathAddArc(path, m, x, y, radius, startAngle, endAngle, clockwise)

Appends an arc to a mutable graphics path, possibly preceded by a straight line segment.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
x (Float) —

The x-coordinate of the center point of the arc.
y (Float) —

The y-coordinate of the center point of the arc.
radius (Float) —

The radius of the arc.
startAngle (Float) —

The angle (in radians) that determines the starting point of the arc, measured from the x-axis in the current user space.
endAngle (Float) —

The angle (in radians) that determines the ending point of the arc, measured from the x-axis in the current user space.
clockwise (Boolean) —

A Boolean value that specifies whether or not to draw the arc in the clockwise direction, before applying the transformation matrix.

Returns:

(Object) —

Returns true if the point is contained in the path; false otherwise.

- (`Object`) CGPathAddArcToPoint(path, m, x1, y1, x2, y2, radius)

Appends an arc to a mutable graphics path, possibly preceded by a straight line segment.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
x1 (Float) —

The x-coordinate of the center point of the arc.
y1 (Float) —

The y-coordinate of the center point of the arc.
x2 (Float) —

The radius of the arc.
y2 (Float) —

The angle (in radians) that determines the starting point of the arc, measured from the x-axis in the current user space.
radius (Float) —

The angle (in radians) that determines the ending point of the arc, measured from the x-axis in the current user space.

Returns:

(Object) —

A new, immutable copy of the specified path. You are responsible for releasing this object.

- (`Object`) CGPathAddCurveToPoint(path, m, cp1x, cp1y, cp2x, cp2y, x, y)

Appends a cubic Bézier curve to a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
cp1x (Float) —

The x-coordinate of the center point of the arc.
cp1y (Float) —

The y-coordinate of the center point of the arc.
cp2x (Float) —

The radius of the arc.
cp2y (Float) —

The angle (in radians) that determines the starting point of the arc, measured from the x-axis in the current user space.
x (Float) —

The angle (in radians) that determines the ending point of the arc, measured from the x-axis in the current user space.
y (Float) —

A Boolean value that specifies whether or not to draw the arc in the clockwise direction, before applying the transformation matrix.

Returns:

(Object) —

A new, immutable path. You are responsible for releasing this object.

- (`Object`) CGPathAddEllipseInRect(path, m, rect)

Adds to a path an ellipse that fits inside a rectangle.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
rect (CGRect) —

The x-coordinate of the center point of the arc.

Returns:

(Object) —

A new, immutable path. You are responsible for releasing this object.

- (`Object`) CGPathAddLines(path, m, points[], count)

Appends an array of new line segments to a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
points[] (const CGPoint) —

The x-coordinate of the center point of the arc.
count (size_t) —

The y-coordinate of the center point of the arc.

Returns:

(Object) —

A new, immutable copy of the path. You are responsible for releasing this object.

- (`Object`) CGPathAddLineToPoint(path, m, x, y)

Appends a line segment to a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
x (Float) —

The x-coordinate of the center point of the arc.
y (Float) —

The y-coordinate of the center point of the arc.

Returns:

(Object) —

A new mutable path. You are responsible for releasing this object.

- (`Object`) CGPathAddPath(path1, m, path2)

Appends a path to onto a mutable graphics path.

Parameters:

path1 (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
path2 (CGPathRef) —

The x-coordinate of the center point of the arc.

Returns:

(Object) —

A new, mutable, copy of the specified path. You are responsible for releasing this object.

- (`Object`) CGPathAddQuadCurveToPoint(path, m, cpx, cpy, x, y)

Appends a quadratic Bézier curve to a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
cpx (Float) —

The x-coordinate of the center point of the arc.
cpy (Float) —

The y-coordinate of the center point of the arc.
x (Float) —

The radius of the arc.
y (Float) —

The angle (in radians) that determines the starting point of the arc, measured from the x-axis in the current user space.

Returns:

(Object) —

A new, mutable copy of the specified path transformed by the transform parameter. You are responsible for releasing this object.

- (`Object`) CGPathAddRect(path, m, rect)

Appends a rectangle to a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
rect (CGRect) —

The x-coordinate of the center point of the arc.

Returns:

(Object) —

A new, immutable path. You are responsible for releasing this object.

- (`Object`) CGPathAddRects(path, m, rects[], count)

Appends an array of rectangles to a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
rects[] (const CGRect) —

The x-coordinate of the center point of the arc.
count (size_t) —

The y-coordinate of the center point of the arc.

Returns:

(Object) —

A new, immutable path. You are responsible for releasing this object.

- (`Object`) CGPathAddRelativeArc(path, matrix, x, y, radius, startAngle, delta)

Appends an arc to a mutable graphics path, possibly preceded by a straight line segment.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
matrix (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
x (Float) —

The x-coordinate of the center point of the arc.
y (Float) —

The y-coordinate of the center point of the arc.
radius (Float) —

The radius of the arc.
startAngle (Float) —

The angle (in radians) that determines the starting point of the arc, measured from the x-axis in the current user space.
delta (Float) —

The angle (in radians) that determines the ending point of the arc, measured from the x-axis in the current user space.

Returns:

(Object) —

A Boolean value that indicates whether or not the two specified paths contain the same sequence of path elements. If the paths are not the same, returns false.

- (`Object`) CGPathApply(path, info, function)

For each element in a graphics path, calls a custom applier function.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
info (Object) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
function (CGPathApplierFunction) —

The x-coordinate of the center point of the arc.

Returns:

(Object) —

A rectangle that represents the bounding box of the specified path. If the path is empty, this function returns CGRectNull.

- (`Object`) CGPathCloseSubpath(path)

Closes and completes a subpath in a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.

Returns:

(Object) —

The current point in the specified path.

- (`Boolean`) CGPathContainsPoint(path, m, point, eoFill)

Checks whether a point is contained in a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
point (CGPoint) —

The x-coordinate of the center point of the arc.
eoFill (Boolean) —

The y-coordinate of the center point of the arc.

Returns:

(Boolean) —

A rectangle that represents the path bounding box of the specified path. If the path is empty, this function returns CGRectNull.

- (`CGPathRef`) CGPathCreateCopy(path)

Creates an immutable copy of a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(CGPathRef) —

The Core Foundation identifier for the opaque type CGPathRef.

- (`CGPathRef`) CGPathCreateCopyByDashingPath(path, transform, phase, lengths, count)

Creates a dashed copy of another path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
transform (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
phase (Float) —

The x-coordinate of the center point of the arc.
lengths (const CGFloat) —

The y-coordinate of the center point of the arc.
count (size_t) —

The radius of the arc.

Returns:

(CGPathRef) —

A Boolean value that indicates whether the specified path is empty.

- (`CGPathRef`) CGPathCreateCopyByStrokingPath(path, transform, lineWidth, lineCap, lineJoin, miterLimit)

Creates a stroked copy of another path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
transform (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
lineWidth (Float) —

The x-coordinate of the center point of the arc.
lineCap (CGLineCap) —

The y-coordinate of the center point of the arc.
lineJoin (CGLineJoin) —

The radius of the arc.
miterLimit (Float) —

The angle (in radians) that determines the starting point of the arc, measured from the x-axis in the current user space.

Returns:

(CGPathRef) —

A Boolean value that indicates whether the specified path represents a rectangle. If the path represents a rectangle, returns true.

- (`CGPathRef`) CGPathCreateCopyByTransformingPath(path, transform)

Creates an immutable copy of a graphics path transformed by a transformation matrix.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
transform (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.

Returns:

(CGPathRef) —

The same path you passed in as the path parameter.

- (`CGMutablePathRef`) CGPathCreateMutable

Creates a mutable graphics path.

Returns:

(CGMutablePathRef)

- (`CGMutablePathRef`) CGPathCreateMutableCopy(path)

Creates a mutable copy of an existing graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(CGMutablePathRef)

- (`CGMutablePathRef`) CGPathCreateMutableCopyByTransformingPath(path, transform)

Creates a mutable copy of a graphics path transformed by a transformation matrix.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
transform (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.

Returns:

(CGMutablePathRef)

- (`CGPathRef`) CGPathCreateWithEllipseInRect(rect, transform)

Create an immutable path of an ellipse.

Parameters:

rect (CGRect) —

The mutable graphics path to change.
transform (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.

Returns:

(CGPathRef)

- (`CGPathRef`) CGPathCreateWithRect(rect, transform)

Create an immutable path of a rectangle.

Parameters:

rect (CGRect) —

The mutable graphics path to change.
transform (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.

Returns:

(CGPathRef)

- (`Boolean`) CGPathEqualToPath(path1, path2)

Indicates whether two graphics paths are equivalent.

Parameters:

path1 (CGPathRef) —

The mutable graphics path to change.
path2 (CGPathRef) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.

Returns:

(Boolean)

- (`CGRect`) CGPathGetBoundingBox(path)

Returns the bounding box containing all points in a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(CGRect)

- (`CGPoint`) CGPathGetCurrentPoint(path)

Returns the current point in a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(CGPoint)

- (`CGRect`) CGPathGetPathBoundingBox(path)

Returns the bounding box of a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(CGRect)

- (`CFTypeID`) CGPathGetTypeID

Returns the Core Foundation type identifier for Quartz graphics paths.

Returns:

(CFTypeID)

- (`Boolean`) CGPathIsEmpty(path)

Indicates whether or not a graphics path is empty.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(Boolean)

- (`Boolean`) CGPathIsRect(path, rect)

Indicates whether or not a graphics path represents a rectangle.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.
rect (CGRect) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.

Returns:

(Boolean)

- (`nil`) CGPathMoveToPoint(path, m, x, y)

Starts a new subpath at a specified location in a mutable graphics path.

Parameters:

path (CGMutablePathRef) —

The mutable graphics path to change.
m (const CGAffineTransform) —

A pointer to an affine transformation matrix, or NULL if no transformation is needed. If specified, Quartz applies the transformation to the arc before it is added to the path.
x (Float) —

The x-coordinate of the center point of the arc.
y (Float) —

The y-coordinate of the center point of the arc.

Returns:

(nil)

- (`nil`) CGPathRelease(path)

Decrements the retain count of a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(nil)

- (`CGPathRef`) CGPathRetain(path)

Increments the retain count of a graphics path.

Parameters:

path (CGPathRef) —

The mutable graphics path to change.

Returns:

(CGPathRef)

- (`CGPatternRef`) CGPatternCreate(info, bounds, matrix, xStep, yStep, tiling, isColored, callbacks)

Creates a pattern object.

Parameters:

info (Object) —

A pointer to private storage used by your pattern drawing function, or NULL. For more information, see the discussion below.
bounds (CGRect) —

The bounding box of the pattern cell, specified in pattern space. (Pattern space is an abstract space that maps to the default user space by the transformation matrix you specify with the matrix parameter.) The drawing done in your pattern drawing function is clipped to this rectangle.
matrix (CGAffineTransform) —

A matrix that represents a transform from pattern space to the default user space of the context in which the pattern is used. If no transform is needed, pass the identity matrix.
xStep (Float) —

The horizontal displacement between cells, specified in pattern space. For no additional horizontal space between cells (so that each pattern cells abuts the previous pattern cell in the horizontal direction), pass the width of the pattern cell.
yStep (Float) —

The vertical displacement between cells, specified in pattern space. For no additional vertical space between cells (so that each pattern cells abuts the previous pattern cell in the vertical direction), pass the height of the pattern cell.
tiling (CGPatternTiling) —

A CGPatternTiling constant that specifies the desired tiling method. For more information about tiling methods, see “Tiling Patterns”.
isColored (Boolean) —

If you want to draw your pattern using its own intrinsic color, pass true. If you want to draw an uncolored (or masking) pattern that uses the fill or stroke color in the graphics state, pass false.
callbacks (const CGPatternCallbacks) —

A pointer to a pattern callback function table—your pattern drawing function is an entry in this table. See CGPatternCallbacks for more information about callback function tables for patterns.

Returns:

(CGPatternRef) —

A new Quartz pattern. You are responsible for releasing this object using CGPatternRelease.

- (`CFTypeID`) CGPatternGetTypeID

Returns the type identifier for Quartz patterns.

Returns:

(CFTypeID) —

The identifier for the opaque type CGPatternRef.

- (`Object`) CGPatternRelease(pattern)

Decrements the retain count of a Quartz pattern.

Parameters:

pattern (CGPatternRef) —

A pointer to private storage used by your pattern drawing function, or NULL. For more information, see the discussion below.

Returns:

(Object) —

The same pattern you passed in as the pattern parameter.

- (`CGPatternRef`) CGPatternRetain(pattern)

Increments the retain count of a Quartz pattern.

Parameters:

pattern (CGPatternRef) —

A pointer to private storage used by your pattern drawing function, or NULL. For more information, see the discussion below.

Returns:

(CGPatternRef)

- (`Boolean`) CGPDFArrayGetArray(array, index, value)

Returns whether an object at a given index in a PDF array is another PDF array and, if so, retrieves that array.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFArrayRef) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF array at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetBoolean(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF Boolean and, if so, retrieves that Boolean.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFBoolean) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF Boolean at the specified index, otherwise false.

- (`size_t`) CGPDFArrayGetCount(array)

Returns the number of items in a PDF array.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.

Returns:

(size_t) —

Returns the number of items in the array.

- (`Boolean`) CGPDFArrayGetDictionary(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF dictionary and, if so, retrieves that dictionary.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFDictionaryRef) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF dictionary at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetInteger(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF integer and, if so, retrieves that object.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFInteger) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF integer at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetName(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF name reference (represented as a constant C string) and, if so, retrieves that name.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (Pointer) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is an array of characters at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetNull(array, index)

Returns whether an object at a given index in a Quartz PDF array is a PDF null.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.

Returns:

(Boolean) —

Returns true if there is a PDF null at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetNumber(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF number and, if so, retrieves that object.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFReal) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF number at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetObject(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF object and, if so, retrieves that object.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFObjectRef) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF object at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetStream(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF stream and, if so, retrieves that stream.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFStreamRef) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF stream at the specified index, otherwise false.

- (`Boolean`) CGPDFArrayGetString(array, index, value)

Returns whether an object at a given index in a PDF array is a PDF string and, if so, retrieves that string.

Parameters:

array (CGPDFArrayRef) —

A PDF array. If this parameter is not a valid PDF array, the behavior is undefined.
index (size_t) —

The index of the value to retrieve. If the index is outside the index space of the array (0 to N-1, where N is the count of the array), the behavior is undefined.
value (CGPDFStringRef) —

On input, a pointer to a PDF array. If the value at the specified index is a PDF array, then on return that array, otherwise the value is unspecified.

Returns:

(Boolean) —

Returns true if there is a PDF stream at the specified index, otherwise false.

- (`CGPDFContentStreamRef`) CGPDFContentStreamCreateWithPage(page)

Creates a content stream object from a PDF page object.

Parameters:

page (CGPDFPageRef) —

A PDF page object.

Returns:

(CGPDFContentStreamRef) —

A new CGPDFContentStream object. You are responsible for releasing this object by calling the function CGPDFContentStreamRelease.

- (`CGPDFContentStreamRef`) CGPDFContentStreamCreateWithStream(stream, streamResources, parent)

Creates a PDF content stream object from an existing PDF content stream object.

Parameters:

stream (CGPDFStreamRef) —

A PDF page object.
streamResources (CGPDFDictionaryRef) —

The PDF stream you want to create a content stream from.
parent (CGPDFContentStreamRef) —

A PDF dictionary that contains the resources associated with the stream you want to retrieve.

Returns:

(CGPDFContentStreamRef) —

A CGPDFContentStream object created from the stream parameter. You are responsible for releasing this object by calling the function CGPDFContentStreamRelease.

- (`CGPDFObjectRef`) CGPDFContentStreamGetResource(cs, category, name)

Gets the specified resource from a PDF content stream object.

Parameters:

cs (CGPDFContentStreamRef) —

A PDF page object.
category (const char) —

The PDF stream you want to create a content stream from.
name (const char) —

A PDF dictionary that contains the resources associated with the stream you want to retrieve.

Returns:

(CGPDFObjectRef) —

The resource dictionary.

- (`CFArrayRef`) CGPDFContentStreamGetStreams(cs)

Gets the array of PDF content streams contained in a PDF content stream object.

Parameters:

cs (CGPDFContentStreamRef) —

A PDF page object.

Returns:

(CFArrayRef) —

The array of PDF content streams that make up the content stream object represented by the cs parameter.

- (`Object`) CGPDFContentStreamRelease(cs)

Decrements the retain count of a PDF content stream object.

Parameters:

cs (CGPDFContentStreamRef) —

A PDF page object.

Returns:

(Object) —

The same PDF content stream you passed in as the cs parameter.

- (`CGPDFContentStreamRef`) CGPDFContentStreamRetain(cs)

Increments the retain count of a PDF content stream object.

Parameters:

cs (CGPDFContentStreamRef) —

A PDF page object.

Returns:

(CGPDFContentStreamRef)

- (`Object`) CGPDFContextAddDestinationAtPoint(context, name, point)

Sets a destination to jump to when a point in the current page of a PDF graphics context is clicked.

Parameters:

context (CGContextRef) —

A PDF graphics context.
name (CFStringRef) —

A destination name.
point (CGPoint) —

A location in the current page of the PDF graphics context.

Returns:

(Object) —

A new PDF context, or NULL if the context cannot be created. You are responsible for releasing this object using CGContextRelease.

- (`Object`) CGPDFContextAddDocumentMetadata(context, metadata)

Associates custom metadata with the PDF document.

Parameters:

context (CGContextRef) —

A PDF graphics context.
metadata (CFDataRef) —

A destination name.

Returns:

(Object) —

A new PDF context, or NULL if a context could not be created. You are responsible for releasing this object using CGContextRelease.

- (`nil`) CGPDFContextBeginPage(context, pageInfo)

Begins a new page in a PDF graphics context.

Parameters:

context (CGContextRef) —

A PDF graphics context.
pageInfo (CFDictionaryRef) —

A destination name.

Returns:

(nil)

- (`nil`) CGPDFContextClose(context)

Closes a PDF document.

Parameters:

context (CGContextRef) —

A PDF graphics context.

Returns:

(nil)

- (`CGContextRef`) CGPDFContextCreate(consumer, mediaBox, auxiliaryInfo)

Creates a PDF graphics context.

Parameters:

consumer (CGDataConsumerRef) —

A PDF graphics context.
mediaBox (const CGRect) —

A destination name.
auxiliaryInfo (CFDictionaryRef) —

A location in the current page of the PDF graphics context.

Returns:

(CGContextRef)

- (`CGContextRef`) CGPDFContextCreateWithURL(url, mediaBox, auxiliaryInfo)

Creates a URL-based PDF graphics context.

Parameters:

url (CFURLRef) —

A PDF graphics context.
mediaBox (const CGRect) —

A destination name.
auxiliaryInfo (CFDictionaryRef) —

A location in the current page of the PDF graphics context.

Returns:

(CGContextRef)

- (`nil`) CGPDFContextEndPage(context)

Ends the current page in the PDF graphics context.

Parameters:

context (CGContextRef) —

A PDF graphics context.

Returns:

(nil)

- (`nil`) CGPDFContextSetDestinationForRect(context, name, rect)

Sets a destination to jump to when a rectangle in the current PDF page is clicked.

Parameters:

context (CGContextRef) —

A PDF graphics context.
name (CFStringRef) —

A destination name.
rect (CGRect) —

A location in the current page of the PDF graphics context.

Returns:

(nil)

- (`nil`) CGPDFContextSetURLForRect(context, url, rect)

Sets the URL associated with a rectangle in a PDF graphics context.

Parameters:

context (CGContextRef) —

A PDF graphics context.
url (CFURLRef) —

A destination name.
rect (CGRect) —

A location in the current page of the PDF graphics context.

Returns:

(nil)

- (`Object`) CGPDFDictionaryApplyFunction(dict, function, info)

Applies a function to each entry in a dictionary.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
function (CGPDFDictionaryApplierFunction) —

The function to apply to each entry in the dictionary.
info (Object) —

A pointer to contextual information to pass to the function.

Returns:

(Object) —

Returns true if there is a PDF array associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetArray(dict, key, value)

Returns whether there is a PDF array associated with a specified key in a PDF dictionary and, if so, retrieves that array.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFArrayRef) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a PDF Boolean value associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetBoolean(dict, key, value)

Returns whether there is a PDF Boolean value associated with a specified key in a PDF dictionary and, if so, retrieves the Boolean value.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFBoolean) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns the number of entries in the dictionary.

- (`size_t`) CGPDFDictionaryGetCount(dict)

Returns the number of entries in a PDF dictionary.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.

Returns:

(size_t) —

Returns true if there is a PDF dictionary associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetDictionary(dict, key, value)

Returns whether there is another PDF dictionary associated with a specified key in a PDF dictionary and, if so, retrieves that dictionary.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFDictionaryRef) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a PDF integer associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetInteger(dict, key, value)

Returns whether there is a PDF integer associated with a specified key in a PDF dictionary and, if so, retrieves that integer.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFInteger) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a character array associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetName(dict, key, value)

Returns whether an object with a specified key in a PDF dictionary is a PDF name reference (represented as a constant C string) and, if so, retrieves that name.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (Pointer) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a PDF number associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetNumber(dict, key, value)

Returns whether there is a PDF number associated with a specified key in a PDF dictionary and, if so, retrieves that number.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFReal) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a PDF object associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetObject(dict, key, value)

Returns whether there is a PDF object associated with a specified key in a PDF dictionary and, if so, retrieves that object.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFObjectRef) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a PDF stream associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetStream(dict, key, value)

Returns whether there is a PDF stream associated with a specified key in a PDF dictionary and, if so, retrieves that stream.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFStreamRef) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean) —

Returns true if there is a PDF string associated with the specified key; otherwise, false.

- (`Boolean`) CGPDFDictionaryGetString(dict, key, value)

Returns whether there is a PDF string associated with a specified key in a PDF dictionary and, if so, retrieves that string.

Parameters:

dict (CGPDFDictionaryRef) —

A PDF dictionary. If this parameter is not a valid PDF dictionary, the behavior is undefined.
key (const char) —

The function to apply to each entry in the dictionary.
value (CGPDFStringRef) —

A pointer to contextual information to pass to the function.

Returns:

(Boolean)

- (`Boolean`) CGPDFDocumentAllowsCopying(document)

Returns whether the specified PDF document allows copying.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(Boolean) —

A Boolean that, if true, indicates that the document allows copying. If the value is false, the document does not allow copying.

- (`Boolean`) CGPDFDocumentAllowsPrinting(document)

Returns whether a PDF document allows printing.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(Boolean) —

A Boolean that, if true, indicates that the document allows printing. If the value is false, the document does not allow printing.

- (`CGPDFDocumentRef`) CGPDFDocumentCreateWithProvider(provider)

Creates a Quartz PDF document using a data provider.

Parameters:

provider (Object) —

A PDF document.

Returns:

(CGPDFDocumentRef) —

A new Quartz PDF document, or NULL if a document can not be created. You are responsible for releasing the object using CGPDFDocumentRelease.

- (`CGPDFDocumentRef`) CGPDFDocumentCreateWithURL(url)

Creates a Quartz PDF document using data specified by a URL.

Parameters:

url (CFURLRef) —

A PDF document.

Returns:

(CGPDFDocumentRef) —

A new Quartz PDF document, or NULL if a document could not be created. You are responsible for releasing the object using CGPDFDocumentRelease.

- (`CGPDFDictionaryRef`) CGPDFDocumentGetCatalog(document)

Returns the document catalog of a Quartz PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(CGPDFDictionaryRef) —

The document catalog of the specified document.

- (`CGPDFArrayRef`) CGPDFDocumentGetID(document)

Gets the file identifier for a PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(CGPDFArrayRef) —

Returns the file identifier for the document.

- (`CGPDFDictionaryRef`) CGPDFDocumentGetInfo(document)

Gets the information dictionary for a PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(CGPDFDictionaryRef) —

The information dictionary for the document.

- (`size_t`) CGPDFDocumentGetNumberOfPages(document)

Returns the number of pages in a PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(size_t) —

The total number of pages in the PDF document.

- (`CGPDFPageRef`) CGPDFDocumentGetPage(document, pageNumber)

Returns a page from a Quartz PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.
pageNumber (size_t) —

A PDF document.

Returns:

(CGPDFPageRef) —

Return the PDF page corresponding to the specified page number, or NULL if no such page exists in the document. Pages are numbered starting at 1.

- (`CFTypeID`) CGPDFDocumentGetTypeID

Returns the type identifier for Quartz PDF documents.

Returns:

(CFTypeID) —

The identifier for the opaque type CGPDFDocumentRef.

- (`Object`) CGPDFDocumentGetVersion(document, majorVersion, minorVersion)

Returns the major and minor version numbers of a Quartz PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.
majorVersion (Integer) —

A PDF document.
minorVersion (Integer) —

A data provider that supplies the PDF document data.

Returns:

(Object) —

On return, the values of the majorVersion and minorVersion parameters are set to the major and minor version numbers of the document respectively.

- (`Boolean`) CGPDFDocumentIsEncrypted(document)

Returns whether the specified PDF file is encrypted.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(Boolean) —

A Boolean that, if true, indicates that the document is encrypted. If the value is false, the document is not encrypted.

- (`Boolean`) CGPDFDocumentIsUnlocked(document)

Returns whether the specified PDF document is currently unlocked.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(Boolean) —

A Boolean that, if true, indicates that the document is not locked. If the value is false, the document is locked.

- (`Object`) CGPDFDocumentRelease(document)

Decrements the retain count of a PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(Object) —

The same document you passed in as the document parameter.

- (`CGPDFDocumentRef`) CGPDFDocumentRetain(document)

Increments the retain count of a Quartz PDF document.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.

Returns:

(CGPDFDocumentRef) —

A Boolean that, if true, indicates that the document has been successfully unlocked. If the value is false, the document has not been unlocked.

- (`Boolean`) CGPDFDocumentUnlockWithPassword(document, password)

Unlocks an encrypted PDF document, if a valid password is supplied.

Parameters:

document (CGPDFDocumentRef) —

A PDF document.
password (const char) —

A PDF document.

Returns:

(Boolean)

- (`CGPDFObjectType`) CGPDFObjectGetType(object)

Returns the PDF type identifier of an object.

Parameters:

object (CGPDFObjectRef) —

A PDF object. If the value if not a PDF object, the behavior is unspecified.

Returns:

(CGPDFObjectType) —

Returns the type of the object parameter. See “Data Types.”

- (`Boolean`) CGPDFObjectGetValue(object, type, value)

Returns whether an object is of a given type and if it is, retrieves its value.

Parameters:

object (CGPDFObjectRef) —

A PDF object. If the value if not a PDF object, the behavior is unspecified.
type (CGPDFObjectType) —

A PDF object.
value (Object) —

A PDF object type.

Returns:

(Boolean) —

Returns true if the specified object is a PDF object of the specified type, otherwise false.

- (`CGPDFOperatorTableRef`) CGPDFOperatorTableCreate

Creates an empty PDF operator table.

Returns:

(CGPDFOperatorTableRef) —

An empty PDF operator table. You are responsible for releasing this object by calling CGPDFOperatorTableRelease.

- (`Object`) CGPDFOperatorTableRelease(table)

Decrements the retain count of a CGPDFOperatorTable object.

Parameters:

table (CGPDFOperatorTableRef) —

A PDF operator table.

Returns:

(Object) —

The same PDF operator table you passed in as the table parameter.

- (`CGPDFOperatorTableRef`) CGPDFOperatorTableRetain(table)

Increments the retain count of a CGPDFOperatorTable object.

Parameters:

table (CGPDFOperatorTableRef) —

A PDF operator table.

Returns:

(CGPDFOperatorTableRef)

- (`nil`) CGPDFOperatorTableSetCallback(table, name, callback)

Sets a callback function for a PDF operator.

Parameters:

table (CGPDFOperatorTableRef) —

A PDF operator table.
name (const char) —

A PDF operator table.
callback (CGPDFOperatorCallback) —

A PDF operator table.

Returns:

(nil)

- (`CGRect`) CGPDFPageGetBoxRect(page, box)

Returns the rectangle that represents a type of box for a content region or page dimensions of a PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.
box (CGPDFBox) —

A CGPDFBox constant that specifies the type of box. For possible values, see “PDF Boxes”.

Returns:

(CGRect) —

Returns the rectangle associated with the type of box specified by the box parameter in the specified page.

- (`CGPDFDictionaryRef`) CGPDFPageGetDictionary(page)

Returns the dictionary of a PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.

Returns:

(CGPDFDictionaryRef) —

Returns the PDF dictionary for the specified page.

- (`CGPDFDocumentRef`) CGPDFPageGetDocument(page)

Returns the document for a page.

Parameters:

page (CGPDFPageRef) —

A PDF page.

Returns:

(CGPDFDocumentRef) —

The PDF document with which the specified page is associated.

- (`CGAffineTransform`) CGPDFPageGetDrawingTransform(page, box, rect, rotate, preserveAspectRatio)

Returns the affine transform that maps a box to a given rectangle on a PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.
box (CGPDFBox) —

A CGPDFBox constant that specifies the type of box. For possible values, see “PDF Boxes”.
rect (CGRect) —

A PDF page.
rotate (Integer) —

A PDF page.
preserveAspectRatio (Boolean) —

A PDF page.

Returns:

(CGAffineTransform) —

An affine transform that maps the box specified by the box parameter to the rectangle specified by the rect parameter.

- (`size_t`) CGPDFPageGetPageNumber(page)

Returns the page number of the specified PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.

Returns:

(size_t) —

Returns the page number of the specified page.

- (`Integer`) CGPDFPageGetRotationAngle(page)

Returns the rotation angle of a PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.

Returns:

(Integer) —

The rotation angle (in degrees) of the specified page. This is the value of the /Rotate entry in the page’s dictionary.

- (`CFTypeID`) CGPDFPageGetTypeID

Returns the CFType ID for PDF page objects.

Returns:

(CFTypeID) —

Returns the Core Foundation type for a PDF page.

- (`Object`) CGPDFPageRelease(page)

Decrements the retain count of a PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.

Returns:

(Object) —

The same page you passed in as the page parameter.

- (`CGPDFPageRef`) CGPDFPageRetain(page)

Increments the retain count of a PDF page.

Parameters:

page (CGPDFPageRef) —

A PDF page.

Returns:

(CGPDFPageRef)

- (`CGPDFScannerRef`) CGPDFScannerCreate(cs, table, info)

Creates a PDF scanner.

Parameters:

cs (CGPDFContentStreamRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
table (CGPDFOperatorTableRef) —

A table of callbacks for the PDF operators you want to handle.
info (Object) —

A pointer to data you want passed to your callback function. (See CGPDFOperatorTable Reference.)

Returns:

(CGPDFScannerRef) —

A PDF scanner object. You are responsible for releasing this object by calling the function CGPDFScannerRelease.

- (`CGPDFContentStreamRef`) CGPDFScannerGetContentStream(scanner)

Returns the content stream associated with a PDF scanner object.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)

Returns:

(CGPDFContentStreamRef) —

The content stream associated with scanner.

- (`Boolean`) CGPDFScannerPopArray(scanner, value)

Retrieves an array object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFArrayRef) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the array object is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopBoolean(scanner, value)

Retrieves a Boolean object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFBoolean) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the boolean object is retrieved successfully; otherwise,false.

- (`Boolean`) CGPDFScannerPopDictionary(scanner, value)

Retrieves a PDF dictionary object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFDictionaryRef) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the PDF dictionary object is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopInteger(scanner, value)

Retrieves an integer object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFInteger) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the PDF integer is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopName(scanner, value)

Retrieves a character string from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (Pointer) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the string is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopNumber(scanner, value)

Retrieves a real value object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFReal) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the real value is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopObject(scanner, value)

Retrieves an object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFObjectRef) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the object is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopStream(scanner, value)

Retrieves a PDF stream object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFStreamRef) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the stream object is retrieved successfully; otherwise, false.

- (`Boolean`) CGPDFScannerPopString(scanner, value)

Retrieves a string object from the scanner stack.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)
value (CGPDFStringRef) —

A table of callbacks for the PDF operators you want to handle.

Returns:

(Boolean) —

true if the string is retrieved successfully; otherwise, false.

- (`Object`) CGPDFScannerRelease(scanner)

Decrements the retain count of a scanner object.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)

Returns:

(Object) —

The same scanner object passed to the function in the scanner parameter.

- (`CGPDFScannerRef`) CGPDFScannerRetain(scanner)

Increments the retain count of a scanner object.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)

Returns:

(CGPDFScannerRef) —

true if the entire stream is parsed successfully; false if parsing fails (for example, if the stream data is corrupted).

- (`Boolean`) CGPDFScannerScan(scanner)

Parses the content stream of a PDF scanner object.

Parameters:

scanner (CGPDFScannerRef) —

A PDF content stream object. (See CGPDFContentStream Reference.)

Returns:

(Boolean)

- (`CFDataRef`) CGPDFStreamCopyData(stream, format)

Returns the data associated with a PDF stream.

Parameters:

stream (CGPDFStreamRef) —

A PDF stream.
format (CGPDFDataFormat) —

On return, contains a constant that specifies the format of the data returned—CGPDFDataFormatRaw, CGPDFDataFormatJPEGEncoded, or CGPDFDataFormatJPEG2000.

Returns:

(CFDataRef) —

A CFData object that contains a copy of the stream data. You are responsible for releasing this object.

- (`CGPDFDictionaryRef`) CGPDFStreamGetDictionary(stream)

Returns the dictionary associated with a PDF stream.

Parameters:

stream (CGPDFStreamRef) —

A PDF stream.

Returns:

(CGPDFDictionaryRef) —

The PDF dictionary for the specified stream.

- (`CFDateRef`) CGPDFStringCopyDate(string)

Converts a string to a date.

Parameters:

string (CGPDFStringRef) —

The string to convert to a date.

Returns:

(CFDateRef) —

A CFDate object.

- (`CFStringRef`) CGPDFStringCopyTextString(string)

Returns a CFString object that represents a PDF string as a text string.

Parameters:

string (CGPDFStringRef) —

The string to convert to a date.

Returns:

(CFStringRef) —

Returns a CFString object that represents the specified PDF string as a text string. You are responsible for releasing this object.

- (`const`) CGPDFStringGetBytePtr(string)

Returns a pointer to the bytes of a PDF string.

Parameters:

string (CGPDFStringRef) —

The string to convert to a date.

Returns:

(const) —

Returns a pointer to the bytes of the specified string. If the string is NULL, the function returns NULL.

- (`size_t`) CGPDFStringGetLength(string)

Returns the number of bytes in a PDF string.

Parameters:

string (CGPDFStringRef) —

The string to convert to a date.

Returns:

(size_t) —

Returns the number of bytes referenced by the string, or 0 if the string is NULL.

- (`CGPoint`) CGPointApplyAffineTransform(point, t)

Returns the point resulting from an affine transformation of an existing point.

Parameters:

point (CGPoint) —

The first affine transform.
t (CGAffineTransform) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGPoint) —

A new point resulting from applying the specified affine transform to the existing point.

- (`CFDictionaryRef`) CGPointCreateDictionaryRepresentation(point)

Returns a dictionary representation of the specified point.

Parameters:

point (CGPoint) —

A point.

Returns:

(CFDictionaryRef) —

The dictionary representation of the point.

- (`Boolean`) CGPointEqualToPoint(point1, point2)

Returns whether two points are equal.

Parameters:

point1 (CGPoint) —

A point.
point2 (CGPoint) —

The first point to examine.

Returns:

(Boolean) —

true if the two specified points are the same; otherwise, false.

- (`CGPoint`) CGPointFromString(string)

Returns a Core Graphics point structure corresponding to the data in a given string.

Parameters:

string (String) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(CGPoint) —

A Core Graphics structure that represents a point. If the string is not well-formed, the function returns CGPointZero.

- (`CGPoint`) CGPointMake(x, y)

Returns a point with the specified coordinates.

Parameters:

x (Float) —

A point.
y (Float) —

The first point to examine.

Returns:

(CGPoint) —

A point.

- (`Boolean`) CGPointMakeWithDictionaryRepresentation(dict, point)

Fills in a point using the contents of the specified dictionary.

Parameters:

dict (CFDictionaryRef) —

A point.
point (CGPoint) —

The first point to examine.

Returns:

(Boolean) —

true if successful; otherwise false.

- (`CGRect`) CGRectApplyAffineTransform(rect, t)

Applies an affine transform to a rectangle.

Parameters:

rect (CGRect) —

The first affine transform.
t (CGAffineTransform) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGRect) —

The transformed rectangle.

- (`Boolean`) CGRectContainsPoint(rect, point)

Returns whether a rectangle contains a specified point.

Parameters:

rect (CGRect) —

A point.
point (CGPoint) —

The first point to examine.

Returns:

(Boolean) —

true if the rectangle is not null or empty and the point is located within the rectangle; otherwise, false.

- (`Boolean`) CGRectContainsRect(rect1, rect2)

Returns whether the first rectangle contains the second rectangle.

Parameters:

rect1 (CGRect) —

A point.
rect2 (CGRect) —

The first point to examine.

Returns:

(Boolean) —

true if the rectangle specified by rect2 is contained in the rectangle passed in rect1; otherwise, false. The first rectangle contains the second if the union of the two rectangles is equal to the first rectangle.

- (`CFDictionaryRef`) CGRectCreateDictionaryRepresentation(rect)

Returns a dictionary representation of the provided rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(CFDictionaryRef) —

The dictionary representation of the rectangle.

- (`Object`) CGRectDivide(rect, slice, remainder, amount, edge)

Divides a source rectangle into two component rectangles.

Parameters:

rect (CGRect) —

A point.
slice (CGRect) —

The first point to examine.
remainder (CGRect) —

The second point to examine.
amount (Float) —

The x-coordinate of the point to construct.
edge (CGRectEdge) —

The y-coordinate of the point to construct.

Returns:

(Object) —

true if the two specified rectangles have equal size and origin values, or if both rectangles are null rectangles. Otherwise, false.

- (`Boolean`) CGRectEqualToRect(rect1, rect2)

Returns whether two rectangles are equal in size and position.

Parameters:

rect1 (CGRect) —

A point.
rect2 (CGRect) —

The first point to examine.

Returns:

(Boolean) —

The height of the specified rectangle.

- (`CGRect`) CGRectFromString(string)

Returns a Core Graphics rectangle structure corresponding to the data in a given string.

Parameters:

string (String) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(CGRect) —

A Core Graphics structure that represents a rectangle. If the string is not well-formed, the function returns CGRectZero.

- (`Float`) CGRectGetHeight(rect)

Returns the height of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The x-coordinate of the top-right corner of the specified rectangle.

- (`Float`) CGRectGetMaxX(rect)

Returns the x-coordinate that establishes the right edge of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The y-coordinate of the top-right corner of the specified rectangle.

- (`Float`) CGRectGetMaxY(rect)

Returns the y-coordinate that establishes the top edge of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The x-coordinate of the center of the specified rectangle.

- (`Float`) CGRectGetMidX(rect)

Returns the x- coordinate that establishes the center of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The y-coordinate of the center of the specified rectangle.

- (`Float`) CGRectGetMidY(rect)

Returns the y-coordinate that establishes the center of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The x-coordinate of the bottom-left corner of the specified rectangle.

- (`Float`) CGRectGetMinX(rect)

Returns the x-coordinate that establishes the left edge of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The y-coordinate of the bottom-left corner of the specified rectangle.

- (`Float`) CGRectGetMinY(rect)

Returns the y-coordinate that establishes the bottom edge of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

The width of the specified rectangle.

- (`Float`) CGRectGetWidth(rect)

Returns the width of a rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Float) —

A rectangle. The origin value is offset in the x-axis by the distance specified by the dx parameter and in the y-axis by the distance specified by the dy parameter, and its size adjusted by (2*dx,2*dy), relative to the source rectangle. If dx and dy are positive values, then the rectangle’s size is decreased. If dx and dy are negative values, the rectangle’s size is increased.

- (`CGRect`) CGRectInset(rect, dx, dy)

Returns a rectangle that is smaller or larger than the source rectangle, with the same center point.

Parameters:

rect (CGRect) —

A point.
dx (Float) —

The first point to examine.
dy (Float) —

The second point to examine.

Returns:

(CGRect) —

A rectangle with the smallest integer values for its origin and size that contains the source rectangle. That is, given a rectangle with fractional origin or size values, CGRectIntegral rounds the rectangle’s origin downward and its size upward to the nearest whole integers, such that the result contains the original rectangle.

- (`CGRect`) CGRectIntegral(rect)

Returns the smallest rectangle that results from converting the source rectangle values to integers.

Parameters:

rect (CGRect) —

A point.

Returns:

(CGRect) —

A rectangle that represents the intersection of the two specified rectangles. If the two rectangles do not intersect, returns the null rectangle. To check for this condition, use CGRectIsNull.

- (`CGRect`) CGRectIntersection(r1, r2)

Returns the intersection of two rectangles.

Parameters:

r1 (CGRect) —

A point.
r2 (CGRect) —

The first point to examine.

Returns:

(CGRect) —

true if the two specified rectangles intersect; otherwise, false. The first rectangle intersects the second if the intersection of the rectangles is not equal to the null rectangle.

- (`Boolean`) CGRectIntersectsRect(rect1, rect2)

Returns whether two rectangles intersect.

Parameters:

rect1 (CGRect) —

A point.
rect2 (CGRect) —

The first point to examine.

Returns:

(Boolean) —

true if the specified rectangle is empty; otherwise, false.

- (`Boolean`) CGRectIsEmpty(rect)

Returns whether a rectangle has zero width or height, or is a null rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Boolean) —

Returns true if the specified rectangle is infinite; otherwise, false.

- (`Boolean`) CGRectIsInfinite(rect)

Returns whether a rectangle is infinite.

Parameters:

rect (CGRect) —

A point.

Returns:

(Boolean) —

true if the specified rectangle is null; otherwise, false.

- (`Boolean`) CGRectIsNull(rect)

Returns whether the rectangle is equal to the null rectangle.

Parameters:

rect (CGRect) —

A point.

Returns:

(Boolean) —

A rectangle with the specified location and dimensions.

- (`CGRect`) CGRectMake(x, y, width, height)

Returns a rectangle with the specified coordinate and size values.

Parameters:

x (Float) —

A point.
y (Float) —

The first point to examine.
width (Float) —

The second point to examine.
height (Float) —

The x-coordinate of the point to construct.

Returns:

(CGRect) —

true if successful; otherwise, false.

- (`Boolean`) CGRectMakeWithDictionaryRepresentation(dict, rect)

Fills in a rectangle using the contents of the specified dictionary.

Parameters:

dict (CFDictionaryRef) —

A point.
rect (CGRect) —

The first point to examine.

Returns:

(Boolean) —

A rectangle that is the same size as the source, but with its origin offset by dx units along the x-axis and dy units along the y-axis with respect to the source.

- (`CGRect`) CGRectOffset(rect, dx, dy)

Returns a rectangle with an origin that is offset from that of the source rectangle.

Parameters:

rect (CGRect) —

A point.
dx (Float) —

The first point to examine.
dy (Float) —

The second point to examine.

Returns:

(CGRect) —

A rectangle that represents the source rectangle, but with positive width and height values.

- (`CGRect`) CGRectStandardize(rect)

Returns a rectangle with a positive width and height.

Parameters:

rect (CGRect) —

A point.

Returns:

(CGRect) —

The smallest rectangle that completely contains both of the source rectangles.

- (`CGRect`) CGRectUnion(r1, r2)

Returns the smallest rectangle that contains the two source rectangles.

Parameters:

r1 (CGRect) —

A point.
r2 (CGRect) —

The first point to examine.

Returns:

(CGRect) —

The dictionary representation of the size.

- (`CGShadingRef`) CGShadingCreateAxial(colorspace, start, end)

Creates a shading object to use for axial shading.

Parameters:

colorspace (CGColorSpaceRef) —

The color space in which color values are expressed. Quartz retains this object; upon return, you may safely release it.
start (CGPoint) —

The starting point of the axis, in the shading's target coordinate space.
end (CGPoint) —

The ending point of the axis, in the shading's target coordinate space.
function (CGFunctionRef) —

A CGFunction object created by the function CGFunctionCreate. This object refers to your function for creating an axial shading. Quartz retains this object; upon return, you may safely release it.
extendStart (Boolean) —

A Boolean value that specifies whether to extend the shading beyond the starting point of the axis.
extendEnd (Boolean) —

A Boolean value that specifies whether to extend the shading beyond the ending point of the axis.

Returns:

(CGShadingRef) —

A new Quartz axial shading. You are responsible for releasing this object using CGShadingRelease.

- (`CGShadingRef`) CGShadingCreateRadial(colorspace, start, startRadius, end)

Creates a shading object to use for radial shading.

Parameters:

colorspace (CGColorSpaceRef) —

The color space in which color values are expressed. Quartz retains this object; upon return, you may safely release it.
start (CGPoint) —

The starting point of the axis, in the shading's target coordinate space.
startRadius (Float) —

The ending point of the axis, in the shading's target coordinate space.
end (CGPoint) —

A CGFunction object created by the function CGFunctionCreate. This object refers to your function for creating an axial shading. Quartz retains this object; upon return, you may safely release it.
endRadius (Float) —

A Boolean value that specifies whether to extend the shading beyond the starting point of the axis.
function (CGFunctionRef) —

A Boolean value that specifies whether to extend the shading beyond the ending point of the axis.
extendStart (Boolean) —

The color space in which color values are expressed. Quartz retains this object; upon return, you may safely release it.
extendEnd (Boolean) —

The center of the starting circle, in the shading's target coordinate space.

Returns:

(CGShadingRef) —

A new Quartz radial shading. You are responsible for releasing this object using CGShadingRelease.

- (`CFTypeID`) CGShadingGetTypeID

Returns the Core Foundation type identifier for Quartz shading objects.

Returns:

(CFTypeID) —

The Core Foundation identifier for the opaque type CGShadingRef.

- (`Object`) CGShadingRelease(shading)

Decrements the retain count of a shading object.

Parameters:

shading (CGShadingRef) —

The color space in which color values are expressed. Quartz retains this object; upon return, you may safely release it.

Returns:

(Object) —

The same shading object you passed in as the shading parameter.

- (`CGShadingRef`) CGShadingRetain(shading)

Increments the retain count of a shading object.

Parameters:

shading (CGShadingRef) —

The color space in which color values are expressed. Quartz retains this object; upon return, you may safely release it.

Returns:

(CGShadingRef)

- (`CGSize`) CGSizeApplyAffineTransform(size, t)

Returns the height and width resulting from a transformation of an existing height and width.

Parameters:

size (CGSize) —

The first affine transform.
t (CGAffineTransform) —

The second affine transform. This affine transform is concatenated to the first affine transform.

Returns:

(CGSize) —

A new size resulting from applying the specified affine transform to the existing size.

- (`CFDictionaryRef`) CGSizeCreateDictionaryRepresentation(size)

Returns a dictionary representation of the specified size.

Parameters:

size (CGSize) —

A point.

Returns:

(CFDictionaryRef) —

true if the two specified sizes are equal; otherwise, false.

- (`Boolean`) CGSizeEqualToSize(size1, size2)

Returns whether two sizes are equal.

Parameters:

size1 (CGSize) —

A point.
size2 (CGSize) —

The first point to examine.

Returns:

(Boolean) —

Returns a CGSize structure with the specified width and height.

- (`CGSize`) CGSizeFromString(string)

Returns a Core Graphics size structure corresponding to the data in a given string.

Parameters:

string (String) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(CGSize) —

A Core Graphics structure that represents a size. If the string is not well-formed, the function returns CGSizeZero.

- (`CGSize`) CGSizeMake(width, height)

Returns a size with the specified dimension values.

Parameters:

width (Float) —

A point.
height (Float) —

The first point to examine.

Returns:

(CGSize) —

true if successful; otherwise, false.

- (`Boolean`) CGSizeMakeWithDictionaryRepresentation(dict, size)

Fills in a size using the contents of the specified dictionary.

Parameters:

dict (CFDictionaryRef) —

A point.
size (CGSize) —

The first point to examine.

Returns:

(Boolean)

- (`CFTypeRef`) CVBufferGetAttachment(buffer, key, attachmentMode)

Returns a specific attachment of a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.
key (CFStringRef) —

A key in the form of a Core Foundation string identifying the desired attachment.
attachmentMode (CVAttachmentMode) —

On output, attachmentMode points to the mode of the attachment. See “CVBuffer Attachment Modes” for possible values. If the attachment mode is not defined, this parameter returns NULL.

Returns:

(CFTypeRef) —

If found, the specified attachment.

- (`CFDictionaryRef`) CVBufferGetAttachments(buffer, attachmentMode)

Returns all attachments of a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.
attachmentMode (CVAttachmentMode) —

A key in the form of a Core Foundation string identifying the desired attachment.

Returns:

(CFDictionaryRef) —

A Core Foundation dictionary with all buffer attachments identified by keys. If no attachment is present, the dictionary is empty. Returns NULL for an invalid attachment mode.

- (`Object`) CVBufferPropagateAttachments(sourceBuffer, destinationBuffer)

Copies all attachments that can be propagated from one Core Video buffer to another.

Parameters:

sourceBuffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.
destinationBuffer (CVBufferRef) —

A key in the form of a Core Foundation string identifying the desired attachment.

Returns:

(Object) —

For convenience, the same Core Video buffer you wanted to retain.

- (`nil`) CVBufferRelease(buffer)

Releases a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.

Returns:

(nil)

- (`nil`) CVBufferRemoveAllAttachments(buffer)

Removes all attachments of a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.

Returns:

(nil)

- (`nil`) CVBufferRemoveAttachment(buffer, key)

Removes a specific attachment of a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.
key (CFStringRef) —

A key in the form of a Core Foundation string identifying the desired attachment.

Returns:

(nil)

- (`CVBufferRef`) CVBufferRetain(buffer)

Retains a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.

Returns:

(CVBufferRef)

- (`nil`) CVBufferSetAttachment(buffer, key, value, attachmentMode)

Sets or adds an attachment of a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.
key (CFStringRef) —

A key in the form of a Core Foundation string identifying the desired attachment.
value (CFTypeRef) —

On output, attachmentMode points to the mode of the attachment. See “CVBuffer Attachment Modes” for possible values. If the attachment mode is not defined, this parameter returns NULL.
attachmentMode (CVAttachmentMode) —

The Core Video buffer whose attachments you want to obtain.

Returns:

(nil)

- (`nil`) CVBufferSetAttachments(buffer, theAttachments, attachmentMode)

Sets a set of attachments for a Core Video buffer.

Parameters:

buffer (CVBufferRef) —

The Core Video buffer whose attachment you want to obtain.
theAttachments (CFDictionaryRef) —

A key in the form of a Core Foundation string identifying the desired attachment.
attachmentMode (CVAttachmentMode) —

On output, attachmentMode points to the mode of the attachment. See “CVBuffer Attachment Modes” for possible values. If the attachment mode is not defined, this parameter returns NULL.

Returns:

(nil)

- (`CGRect`) CVImageBufferGetCleanRect(imageBuffer)

Returns the source rectangle of a Core Video image buffer that represents the clean aperture of the buffer in encoded pixels.

Parameters:

imageBuffer (CVImageBufferRef) —

The image buffer containing the display size to be retrieved.

Returns:

(CGRect) —

A CGRect structure returning the nominal display size of the buffer. Returns a rectangle of zero size if called with either a non-CVImageBufferRef type or NULL.

- (`CGSize`) CVImageBufferGetDisplaySize(imageBuffer)

Returns the nominal output display size, in square pixels, of a Core Video image buffer.

Parameters:

imageBuffer (CVImageBufferRef) —

The image buffer containing the display size to be retrieved.

Returns:

(CGSize) —

A CGSize structure defining the nominal display size of the buffer Returns zero size if called with a non-CVImageBufferRef type or NULL.

- (`CGSize`) CVImageBufferGetEncodedSize(imageBuffer)

Returns the full encoded dimensions of a Core Video image buffer.

Parameters:

imageBuffer (CVImageBufferRef) —

The image buffer containing the display size to be retrieved.

Returns:

(CGSize) —

A CGSize structure defining the full encoded size of the buffer. Returns zero size if called with either a non-CVImageBufferRef type or NULL.

- (`CVReturn`) CVPixelBufferCreate(allocator, width, height, pixelFormatType, pixelBufferAttributes, pixelBufferOut)

Creates a single pixel buffer for a given size and pixel format.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
width (size_t) —

Width of the pixel buffer, in pixels.
height (size_t) —

Height of the pixel buffer, in pixels.
pixelFormatType (OSType) —

The pixel format identified by its respective four-character code (type OSType).
pixelBufferAttributes (CFDictionaryRef) —

A dictionary with additional attributes for a pixel buffer. This parameter is optional. See “Pixel Buffer Attribute Keys” for more details.
pixelBufferOut (CVPixelBufferRef) —

On output, pixelBufferOut points to the newly created pixel buffer.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVReturn`) CVPixelBufferCreateResolvedAttributesDictionary(allocator, attributes, resolvedDictionaryOut)

Takes an array of CFDictionary objects describing various pixel buffer attributes and tries to resolve them into a single dictionary.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
attributes (CFArrayRef) —

Width of the pixel buffer, in pixels.
resolvedDictionaryOut (CFDictionaryRef) —

Height of the pixel buffer, in pixels.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVReturn`) CVPixelBufferCreateWithBytes(allocator, width, height, pixelFormatType, baseAddress, bytesPerRow, releaseCallback, releaseRefCon, pixelBufferAttributes, pixelBufferOut)

Creates a pixel buffer for a given size and pixel format containing data specified by a memory location.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
width (size_t) —

Width of the pixel buffer, in pixels.
height (size_t) —

Height of the pixel buffer, in pixels.
pixelFormatType (OSType) —

The pixel format identified by its respective four-character code (type OSType).
baseAddress (Object) —

A dictionary with additional attributes for a pixel buffer. This parameter is optional. See “Pixel Buffer Attribute Keys” for more details.
bytesPerRow (size_t) —

On output, pixelBufferOut points to the newly created pixel buffer.
releaseCallback (CVPixelBufferReleaseBytesCallback) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
releaseRefCon (Object) —

An array of Core Foundation dictionaries containing pixel buffer attribute key-value pairs.
pixelBufferAttributes (CFDictionaryRef) —

On output, resolvedDictionaryOut points to the consolidated dictionary.
pixelBufferOut (CVPixelBufferRef) —

The allocator to use to create this buffer. Pass NULL to specify the default allocator.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVReturn`) CVPixelBufferCreateWithPlanarBytes(allocator, width, height, pixelFormatType, dataPtr, dataSize, numberOfPlanes, planeBaseAddress[], planeWidth[], planeHeight[], planeBytesPerRow[], releaseCallback, releaseRefCon, pixelBufferAttributes, pixelBufferOut)

Creates a single pixel buffer in planar format for a given size and pixel format containing data specified by a memory location.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
width (size_t) —

Width of the pixel buffer, in pixels.
height (size_t) —

Height of the pixel buffer, in pixels.
pixelFormatType (OSType) —

The pixel format identified by its respective four-character code (type OSType).
dataPtr (Object) —

A dictionary with additional attributes for a pixel buffer. This parameter is optional. See “Pixel Buffer Attribute Keys” for more details.
dataSize (size_t) —

On output, pixelBufferOut points to the newly created pixel buffer.
numberOfPlanes (size_t) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
planeBaseAddress[] (Object) —

An array of Core Foundation dictionaries containing pixel buffer attribute key-value pairs.
planeWidth[] (size_t) —

On output, resolvedDictionaryOut points to the consolidated dictionary.
planeHeight[] (size_t) —

The allocator to use to create this buffer. Pass NULL to specify the default allocator.
planeBytesPerRow[] (size_t) —

The width of the pixel buffer, in pixels.
releaseCallback (CVPixelBufferReleasePlanarBytesCallback) —

The height of the pixel buffer, in pixels.
releaseRefCon (Object) —

The pixel format identified by its respective four character code (type OSType).
pixelBufferAttributes (CFDictionaryRef) —

A pointer to the base address of the memory storing the pixels.
pixelBufferOut (CVPixelBufferRef) —

The row bytes of the pixel storage memory.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVReturn`) CVPixelBufferFillExtendedPixels(pixelBuffer)

Fills the extended pixels of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`Object`) CVPixelBufferGetBaseAddress(pixelBuffer)

Returns the base address of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(Object) —

The base address of the pixels.

- (`Object`) CVPixelBufferGetBaseAddressOfPlane(pixelBuffer, planeIndex)

Returns the base address of the plane at the specified plane index.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
planeIndex (size_t) —

Width of the pixel buffer, in pixels.

Returns:

(Object) —

The base address of the plane, or NULL for nonplanar pixel buffers.

- (`size_t`) CVPixelBufferGetBytesPerRow(pixelBuffer)

Returns the number of bytes per row of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(size_t) —

The number of bytes per row of the image data. For planar buffers, this function returns a rowBytes value such that bytesPerRow * height covers the entire image, including all planes.

- (`size_t`) CVPixelBufferGetBytesPerRowOfPlane(pixelBuffer, planeIndex)

Returns the number of bytes per row for a plane at the specified index in the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
planeIndex (size_t) —

Width of the pixel buffer, in pixels.

Returns:

(size_t) —

The number of row bytes of the plane, or NULL for nonplanar pixel buffers.

- (`size_t`) CVPixelBufferGetDataSize(pixelBuffer)

Returns the data size for contiguous planes of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(size_t) —

The data size as specified in the call to CVPixelBufferCreateWithPlanarBytes.

- (`Object`) CVPixelBufferGetExtendedPixels(pixelBuffer, extraColumnsOnLeft, extraColumnsOnRight, extraRowsOnTop, extraRowsOnBottom)

Returns the amount of extended pixel padding in the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
extraColumnsOnLeft (size_t) —

Width of the pixel buffer, in pixels.
extraColumnsOnRight (size_t) —

Height of the pixel buffer, in pixels.
extraRowsOnTop (size_t) —

The pixel format identified by its respective four-character code (type OSType).
extraRowsOnBottom (size_t) —

A dictionary with additional attributes for a pixel buffer. This parameter is optional. See “Pixel Buffer Attribute Keys” for more details.

Returns:

(Object) —

The buffer height, in pixels.

- (`size_t`) CVPixelBufferGetHeight(pixelBuffer)

Returns the height of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(size_t) —

The height of the buffer, in pixels, or 0 for nonplanar pixel buffers.

- (`size_t`) CVPixelBufferGetHeightOfPlane(pixelBuffer, planeIndex)

Returns the height of the plane at planeIndex in the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
planeIndex (size_t) —

Width of the pixel buffer, in pixels.

Returns:

(size_t) —

A four-character code OSType identifier for the pixel format.

- (`OSType`) CVPixelBufferGetPixelFormatType(pixelBuffer)

Returns the pixel format type of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(OSType) —

The number of planes. Returns 0 for nonplanar pixel buffers.

- (`size_t`) CVPixelBufferGetPlaneCount(pixelBuffer)

Returns number of planes of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(size_t) —

The Core Foundation ID for this type.

- (`CFTypeID`) CVPixelBufferGetTypeID

Returns the Core Foundation ID of the pixel buffer type.

Returns:

(CFTypeID) —

The width of the buffer, in pixels.

- (`size_t`) CVPixelBufferGetWidth(pixelBuffer)

Returns the width of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(size_t) —

The width of the plane, in pixels, or 0 for nonplanar pixel buffers.

- (`size_t`) CVPixelBufferGetWidthOfPlane(pixelBuffer, planeIndex)

Returns the width of the plane at a given index in the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
planeIndex (size_t) —

Width of the pixel buffer, in pixels.

Returns:

(size_t) —

Returns true if the pixel buffer was created using CVPixelBufferCreateWithPlanarBytes; otherwise, false.

- (`Boolean`) CVPixelBufferIsPlanar(pixelBuffer)

Determines whether the pixel buffer is planar.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(Boolean) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVReturn`) CVPixelBufferLockBaseAddress(pixelBuffer, lockFlags)

Locks the base address of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
lockFlags (CVOptionFlags) —

Width of the pixel buffer, in pixels.

Returns:

(CVReturn) —

For convenience, the same pixel buffer you want to retain.

- (`CVReturn`) CVPixelBufferPoolCreate(allocator, poolAttributes, pixelBufferAttributes, poolOut)

Creates a pixel buffer pool.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use for allocating this buffer pool. Pass NULL to specify the default allocator.
poolAttributes (CFDictionaryRef) —

A Core Foundation dictionary containing the attributes for this pixel buffer pool.
pixelBufferAttributes (CFDictionaryRef) —

A Core Foundation dictionary containing the attributes to be used for creating new pixel buffers within the pool.
poolOut (CVPixelBufferPoolRef) —

On output, poolOut points to the newly created pixel buffer pool.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVReturn`) CVPixelBufferPoolCreatePixelBuffer(allocator, pixelBufferPool, pixelBufferOut)

Creates a pixel buffer from a pixel buffer pool.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use for allocating this buffer pool. Pass NULL to specify the default allocator.
pixelBufferPool (CVPixelBufferPoolRef) —

A Core Foundation dictionary containing the attributes for this pixel buffer pool.
pixelBufferOut (CVPixelBufferRef) —

A Core Foundation dictionary containing the attributes to be used for creating new pixel buffers within the pool.

Returns:

(CVReturn) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CFDictionaryRef`) CVPixelBufferPoolGetAttributes(pool)

Returns the pool attributes dictionary for a pixel buffer pool.

Parameters:

pool (CVPixelBufferPoolRef) —

The allocator to use for allocating this buffer pool. Pass NULL to specify the default allocator.

Returns:

(CFDictionaryRef) —

A Core Foundation dictionary containing the pool attributes, or NULL on failure.

- (`CFDictionaryRef`) CVPixelBufferPoolGetPixelBufferAttributes(pool)

Returns the attributes of pixel buffers that will be created from this pool.

Parameters:

pool (CVPixelBufferPoolRef) —

The allocator to use for allocating this buffer pool. Pass NULL to specify the default allocator.

Returns:

(CFDictionaryRef) —

A Core Foundation dictionary containing the pixel buffer attributes, or NULL on failure.

- (`CFTypeID`) CVPixelBufferPoolGetTypeID

Returns the Core Foundation ID of the pixel buffer pool type.

Returns:

(CFTypeID) —

The Core Foundation ID for this type.

- (`Object`) CVPixelBufferPoolRelease(pixelBufferPool)

Releases a pixel buffer pool.

Parameters:

pixelBufferPool (CVPixelBufferPoolRef) —

The allocator to use for allocating this buffer pool. Pass NULL to specify the default allocator.

Returns:

(Object) —

For convenience, the same pixel buffer pool that you wanted to retain.

- (`CVPixelBufferPoolRef`) CVPixelBufferPoolRetain(pixelBufferPool)

Retains a pixel buffer pool.

Parameters:

pixelBufferPool (CVPixelBufferPoolRef) —

The allocator to use for allocating this buffer pool. Pass NULL to specify the default allocator.

Returns:

(CVPixelBufferPoolRef)

- (`Object`) CVPixelBufferRelease(texture)

Releases a pixel buffer.

Parameters:

texture (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(Object) —

A Core Video result code. See Core Video Constants Reference for possible values.

- (`CVPixelBufferRef`) CVPixelBufferRetain(texture)

Retains a pixel buffer.

Parameters:

texture (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.

Returns:

(CVPixelBufferRef)

- (`CVReturn`) CVPixelBufferUnlockBaseAddress(pixelBuffer, unlockFlags)

Unlocks the base address of the pixel buffer.

Parameters:

pixelBuffer (CVPixelBufferRef) —

The allocator to use to create the pixel buffer. Pass NULL to specify the default allocator.
unlockFlags (CVOptionFlags) —

Width of the pixel buffer, in pixels.

Returns:

(CVReturn)

- (`CFArrayRef`) CVPixelFormatDescriptionArrayCreateWithAllPixelFormatTypes(allocator)

Returns all the pixel format descriptions known to Core Video.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use when creating the description. Pass NULL to specify the default allocator.

Returns:

(CFArrayRef) —

An array of Core Foundation dictionaries, each containing a pixel format description. See “Pixel Format Description Keys” for a list of keys relevant to the format description.

- (`CFDictionaryRef`) CVPixelFormatDescriptionCreateWithPixelFormatType(allocator, pixelFormat)

Creates a pixel format description from a given OSType identifier.

Parameters:

allocator (CFAllocatorRef) —

The allocator to use when creating the description. Pass NULL to specify the default allocator.
pixelFormat (OSType) —

The allocator to use when creating the description. Pass NULL to specify the default allocator.

Returns:

(CFDictionaryRef) —

A Core Foundation dictionary containing the pixel format description. See “Pixel Format Description Keys” for a list of keys relevant to the format description.

- (`nil`) CVPixelFormatDescriptionRegisterDescriptionWithPixelFormatType(description, pixelFormat)

Registers a pixel format description with Core Video.

Parameters:

description (CFDictionaryRef) —

The allocator to use when creating the description. Pass NULL to specify the default allocator.
pixelFormat (OSType) —

The allocator to use when creating the description. Pass NULL to specify the default allocator.

Returns:

(nil)

- (`Object`) getParagraphStart(startIndex, end)

Returns by reference the beginning of the first paragraph and the end of the last paragraph touched by the given range. If aRange is contained with a single paragraph, of course, the returned indexes all belong to that paragraph. Similar to getLineStart:end:contentsEnd:forRange:, you can use the results of this method to construct the ranges for paragraphs.

Parameters:

startIndex (Integer) —

Upon return, contains the index of the first character of the paragraph containing the beginning of aRange. Pass NULL if you do not need this value (in which case the work to compute the value isn’t performed).
endIndex (Integer) —

Upon return, contains the index of the first character past the terminator of the paragraph containing the end of aRange. Pass NULL if you do not need this value (in which case the work to compute the value isn’t performed).
contentsEndIndex (Integer) —

Upon return, contains the index of the first character of the terminator of the paragraph containing the end of aRange. Pass NULL if you do not need this value (in which case the work to compute the value isn’t performed).
aRange (NSRange) —

A range within the receiver. The value must not exceed the bounds of the receiver.

Returns:

(Object)

- (`Integer`) hash

Returns an unsigned integer that can be used as a hash table address. If two string objects are equal (as determined by the isEqualToString: method), they must have the same hash value. The abstract implementation of this method fulfills this requirement, so subclasses of NSString shouldn’t override it.You should not rely on this method returning the same hash value across releases of OS X.

Returns:

(Integer) —

An unsigned integer that can be used as a hash table address.

- (`Boolean`) hasPrefix(aString)

Returns a Boolean value that indicates whether a given string matches the beginning characters of the receiver. This method is a convenience for comparing strings using the NSAnchoredSearch option. See String Programming Guide for more information.

Parameters:

aString (String) —

A string.

Returns:

(Boolean) —

YES if aString matches the beginning characters of the receiver, otherwise NO. Returns NO if aString is empty.

- (`Boolean`) hasSuffix(aString)

Returns a Boolean value that indicates whether a given string matches the ending characters of the receiver. This method is a convenience for comparing strings using the NSAnchoredSearch and NSBackwardsSearch options. See String Programming Guide for more information.

Parameters:

aString (String) —

A string.

Returns:

(Boolean) —

YES if aString matches the ending characters of the receiver, otherwise NO. Returns NO if aString is empty.

- (`Object`) init

Returns an initialized NSString object that contains no characters.

Returns:

(Object) —

An initialized NSString object that contains no characters. The returned object may be different from the original receiver.

- (`Object`) initRecurrenceWithFrequency(type, interval:interval, end)

Initializes and returns a simple recurrence rule with a given frequency, interval, and end.

Parameters:

type (EKRecurrenceFrequency) —

The frequency of the recurrence rule. Can be daily, weekly, monthly, or yearly.
interval (Integer) —

The interval between instances of this recurrence. For example, a weekly recurrence rule with an interval of 2 occurs every other week. Must be greater than 0.
end (EKRecurrenceEnd) —

The end of the recurrence rule.

Returns:

(Object) —

The initialized recurrence rule, or nil if invalid values are provided.

- (`Object`) initWithBytes(bytes, length:length, encoding:encoding)

Returns an initialized NSString object containing a given number of bytes from a given buffer of bytes interpreted in a given encoding.

Parameters:

bytes (Object) —

A buffer of bytes interpreted in the encoding specified by encoding.
length (Integer) —

The number of bytes to use from bytes.
encoding (NSStringEncoding) —

The character encoding applied to bytes.

Returns:

(Object) —

An initialized NSString object containing length bytes from bytes interpreted using the encoding encoding. The returned object may be different from the original receiver.

- (`Object`) initWithBytesNoCopy(bytes, length:length, encoding:encoding, freeWhenDone:flag)

Returns an initialized NSString object that contains a given number of bytes from a given buffer of bytes interpreted in a given encoding, and optionally frees the buffer.

Parameters:

bytes (Object) —

A buffer of bytes interpreted in the encoding specified by encoding.
length (Integer) —

The number of bytes to use from bytes.
encoding (NSStringEncoding) —

The character encoding of bytes.
flag (Boolean) —

If YES, the receiver frees the memory when it no longer needs the data; if NO it won’t.

Returns:

(Object) —

An initialized NSString object containing length bytes from bytes interpreted using the encoding encoding. The returned object may be different from the original receiver.

- (`Object`) initWithCharacters(characters, length:length)

Returns an initialized NSString object that contains a given number of characters from a given C array of Unicode characters.

Parameters:

characters (const unichar) —

A C array of Unicode characters; the value must not be NULL.Important: Raises an exception if characters is NULL, even if length is 0.
length (Integer) —

The number of characters to use from characters.

Returns:

(Object) —

An initialized NSString object containing length characters taken from characters. The returned object may be different from the original receiver.

- (`Object`) initWithCharactersNoCopy(characters, length:length, freeWhenDone:flag)

Returns an initialized NSString object that contains a given number of characters from a given C array of Unicode characters.

Parameters:

characters (Integer) —

A C array of Unicode characters.
length (Integer) —

The number of characters to use from characters.
flag (Boolean) —

If YES, the receiver will free the memory when it no longer needs the characters; if NO it won’t.

Returns:

(Object) —

An initialized NSString object that contains length characters from characters. The returned object may be different from the original receiver.

- (`Object`) initWithContentsOfFile(path, encoding:enc, error:error)

Returns an NSString object initialized by reading data from the file at a given path using a given encoding.

Parameters:

path (String) —

A path to a file.
enc (NSStringEncoding) —

The encoding of the file at path.
error (Pointer) —

If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, pass in NULL.

Returns:

(Object) —

An NSString object initialized by reading data from the file named by path using the encoding, enc. The returned object may be different from the original receiver. If the file can’t be opened or there is an encoding error, returns nil.

- (`Object`) initWithContentsOfFile(path, usedEncoding:enc, error:error)

Returns an NSString object initialized by reading data from the file at a given path and returns by reference the encoding used to interpret the characters.

Parameters:

path (String) —

A path to a file.
enc (NSStringEncoding) —

Upon return, if the file is read successfully, contains the encoding used to interpret the file at path.
error (Pointer) —

If an error occurs, upon returns contains an NSError object that describes the problem. If you are not interested in possible errors, pass in NULL.

Returns:

(Object) —

An NSString object initialized by reading data from the file named by path. The returned object may be different from the original receiver. If the file can’t be opened or there is an encoding error, returns nil.

- (`Object`) initWithContentsOfURL(url, encoding:enc, error:error)

Returns an NSString object initialized by reading data from a given URL interpreted using a given encoding.

Parameters:

url (NSURL) —

The URL to read.
enc (NSStringEncoding) —

The encoding of the file at path.
error (Pointer) —

If an error occurs, upon returns contains an NSError object that describes the problem. If you are not interested in possible errors, pass in NULL.

Returns:

(Object) —

An NSString object initialized by reading data from url. The returned object may be different from the original receiver. If the URL can’t be opened or there is an encoding error, returns nil.

- (`Object`) initWithContentsOfURL(url, usedEncoding:enc, error:error)

Returns an NSString object initialized by reading data from a given URL and returns by reference the encoding used to interpret the data.

Parameters:

url (NSURL) —

The URL from which to read data.
enc (NSStringEncoding) —

Upon return, if url is read successfully, contains the encoding used to interpret the data.
error (Pointer) —

If an error occurs, upon returns contains an NSError object that describes the problem. If you are not interested in possible errors, pass in NULL.

Returns:

(Object) —

An NSString object initialized by reading data from url. If url can’t be opened or the encoding cannot be determined, returns nil. The returned initialized object might be different from the original receiver

- (`Object`) initWithCString(nullTerminatedCString, encoding:encoding)

Returns an NSString object initialized using the characters in a given C array, interpreted according to a given encoding. If nullTerminatedCString is not a NULL-terminated C string, or encoding does not match the actual encoding, the results are undefined.

Parameters:

nullTerminatedCString (const char) —

A C array of characters. The array must end with a NULL character; intermediate NULL characters are not allowed.
encoding (NSStringEncoding) —

The encoding of nullTerminatedCString.

Returns:

(Object) —

An NSString object initialized using the characters from nullTerminatedCString. The returned object may be different from the original receiver

- (`Object`) initWithData(data, encoding:encoding)

Returns an NSString object initialized by converting given data into Unicode characters using a given encoding.

Parameters:

data (NSData) —

An NSData object containing bytes in encoding and the default plain text format (that is, pure content with no attributes or other markups) for that encoding.
encoding (NSStringEncoding) —

The encoding used by data.

Returns:

(Object) —

An NSString object initialized by converting the bytes in data into Unicode characters using encoding. The returned object may be different from the original receiver. Returns nil if the initialization fails for some reason (for example if data does not represent valid data for encoding).

- (`Object`) initWithFormat(format, ...)

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted. Invokes initWithFormat:locale:arguments: with nil as the locale, hence using the canonical locale to format numbers. This is useful, for example, if you want to produce "non-localized" formatting which needs to be written out to files and parsed back later.

Parameters:

format —

A format string. See “Formatting String Objects” for examples of how to use this method, and “String Format Specifiers” for a list of format specifiers. This value must not be nil.Important: Raises an NSInvalidArgumentException if format is nil.
... —

A comma-separated list of arguments to substitute into format.

Returns:

(Object) —

An NSString object initialized by using format as a template into which the remaining argument values are substituted according to the canonical locale. The returned object may be different from the original receiver.

- (`Object`) initWithFormat(format, arguments:argList)

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted according to the user’s default locale. Invokes initWithFormat:locale:arguments: with nil as the locale.

Parameters:

format (String) —

A format string. See “Formatting String Objects” for examples of how to use this method, and “String Format Specifiers” for a list of format specifiers. This value must not be nil.Important: Raises an NSInvalidArgumentException if format is nil.
argList (va_list) —

A list of arguments to substitute into format.

Returns:

(Object) —

An NSString object initialized by using format as a template into which the values in argList are substituted according to the user’s default locale. The returned object may be different from the original receiver.

- (`Object`) initWithFormat(format, locale:locale, ...)

Parameters:

format —

A format string. See “Formatting String Objects” for examples of how to use this method, and “String Format Specifiers” for a list of format specifiers. This value must not be nil.Important: Raises an NSInvalidArgumentException if format is nil.
locale —

This may be an instance of NSDictionary containing locale information or an instance of NSLocale. If this value is nil, uses the canonical locale. To use a dictionary containing the current user’s locale, you can use [[NSUserDefaults standardUserDefaults] dictionaryRepresentation].
... —

A comma-separated list of arguments to substitute into format.

Returns:

(Object)

- (`Object`) initWithFormat(format, locale:locale, arguments:argList)

Returns an NSString object initialized by using a given format string as a template into which the remaining argument values are substituted according to given locale information. The following code fragment illustrates how to create a string from myArgs, which is derived from a string object with the value “Cost:” and an int with the value 32: The resulting string has the value “Cost: 32n”.See String Programming Guide for more information.

Parameters:

format (String) —

A format string. See “Formatting String Objects” for examples of how to use this method, and “String Format Specifiers” for a list of format specifiers. This value must not be nil.Important: Raises an NSInvalidArgumentException if format is nil.
locale (Object) —

This may be an instance of NSDictionary containing locale information or an instance of NSLocale. If this value is nil, uses the canonical locale.To use a dictionary containing the current user’s locale, you can use [[NSUserDefaults standardUserDefaults] dictionaryRepresentation].
argList (va_list) —

A list of arguments to substitute into format.

Returns:

(Object) —

An NSString object initialized by using format as a template into which values in argList are substituted according the locale information in locale. The returned object may be different from the original receiver.

- (`Object`) initWithString(aString)

Returns an NSString object initialized by copying the characters from another given string.

Parameters:

aString (String) —

The string from which to copy characters. This value must not be nil.Important: Raises an NSInvalidArgumentException if aString is nil.

Returns:

(Object) —

An NSString object initialized by copying the characters from aString. The returned object may be different from the original receiver.

- (`Object`) initWithUTF8String(bytes)

Returns an NSString object initialized by copying the characters a given C array of UTF8-encoded bytes.

Parameters:

bytes (const char) —

A NULL-terminated C array of bytes in UTF-8 encoding. This value must not be NULL.Important: Raises an exception if bytes is NULL.

Returns:

(Object) —

An NSString object initialized by copying the bytes from bytes. The returned object may be different from the original receiver.

- (`Integer`) integerValue

Returns the NSInteger value of the receiver’s text. This method uses formatting information stored in the non-localized value; use an NSScanner object for localized scanning of numeric values from a string.

Returns:

(Integer) —

The NSInteger value of the receiver’s text, assuming a decimal representation and skipping whitespace at the beginning of the string. Returns 0 if the receiver doesn’t begin with a valid decimal text representation of a number.

- (`Integer`) intValue

Returns the integer value of the receiver’s text. This method uses formatting information stored in the non-localized value; use an NSScanner object for localized scanning of numeric values from a string.

Returns:

(Integer) —

The integer value of the receiver’s text, assuming a decimal representation and skipping whitespace at the beginning of the string. Returns INT_MAX or INT_MIN on overflow. Returns 0 if the receiver doesn’t begin with a valid decimal text representation of a number.

- (`Boolean`) isAbsolutePath

Returning a Boolean value that indicates whether the receiver represents an absolute path. See String Programming Guide for more information on paths.Note that this method only works with file paths (not, for example, string representations of URLs). The method does not check the filesystem for the existence of the path (use fileExistsAtPath: or similar methods in NSFileManager for that task).

Returns:

(Boolean) —

YES if the receiver (if interpreted as a path) represents an absolute path, otherwise NO (if the receiver represents a relative path).

- (`Boolean`) isEqualToString(aString)

Returns a Boolean value that indicates whether a given string is equal to the receiver using a literal Unicode-based comparison. The comparison uses the canonical representation of strings, which for a particular string is the length of the string plus the Unicode characters that make up the string. When this method compares two strings, if the individual Unicodes are the same, then the strings are equal, regardless of the backing store. “Literal” when applied to string comparison means that various Unicode decomposition rules are not applied and Unicode characters are individually compared. So, for instance, “Ö” represented as the composed character sequence “O” and umlaut would not compare equal to “Ö” represented as one Unicode character.

Parameters:

aString (String) —

The string with which to compare the receiver.

Returns:

(Boolean) —

YES if aString is equivalent to the receiver (if they have the same id or if they are NSOrderedSame in a literal comparison), otherwise NO.

- (`String`) lastPathComponent

Returns the last path component of the receiver. Path components are alphanumeric strings delineated by the path separator (slash “/”) or the beginning or end of the path string. Multiple path separators at the end of the string are stripped.The following table illustrates the effect of lastPathComponent on a variety of different paths:Receiver’s String Value String Returned “/tmp/scratch.tiff” “scratch.tiff” “/tmp/scratch” “scratch” “/tmp/” “tmp” “scratch///” “scratch” “/” “/” Note that this method only works with file paths (not, for example, string representations of URLs).

Returns:

(String) —

The last path component of the receiver.

- (`Integer`) length

Returns the number of Unicode characters in the receiver. The number returned includes the individual characters of composed character sequences, so you cannot use this method to determine if a string will be visible when printed or how long it will appear.

Returns:

(Integer) —

The number of Unicode characters in the receiver.

- (`Integer`) lengthOfBytesUsingEncoding(enc)

Returns the number of bytes required to store the receiver in a given encoding. The result is exact and is returned in O(n) time.

Parameters:

enc (NSStringEncoding) —

The encoding for which to determine the receiver's length.

Returns:

(Integer) —

The number of bytes required to store the receiver in the encoding enc in a non-external representation. The length does not include space for a terminating NULL character. Returns 0 if the specified encoding cannot be used to convert the receiver or if the amount of memory required for storing the results of the encoding conversion would exceed NSIntegerMax.

- (`NSRange`) lineRangeForRange(aRange)

Returns the range of characters representing the line or lines containing a given range.

Parameters:

aRange (NSRange) —

A range within the receiver.

Returns:

(NSRange) —

The range of characters representing the line or lines containing aRange, including the line termination characters.

- (`Array`) linguisticTagsInRange(range, scheme:tagScheme, options:opts, orthography:orthography, tokenRanges:tokenRanges)

Returns an array of linguistic tags for the specified range and requested tags within the receiving string. This is a convenience method. It is the equivalent of creating an instance of NSLinguisticTagger, specifying the receiver as the string to be analyzed, and the orthography (or nil) and then invoking the NSLinguisticTagger method or linguisticTagsInRange:scheme:options:orthography:tokenRanges:.

Parameters:

range (NSRange) —

The range of the string to analyze.
tagScheme (String) —

The tag scheme to use. See Linguistic Tag Schemes for supported values.
opts (NSLinguisticTaggerOptions) —

The linguistic tagger options to use. See NSLinguisticTaggerOptions for the constants. These constants can be combined using the C-Bitwise OR operator.
orthography (NSOrthography) —

The orthography of the string. If nil, the linguistic tagger will attempt to determine the orthography from the string content.
tokenRanges (Pointer) —

An array returned by-reference containing the token ranges of the linguistic tags wrapped in NSValue objects.

Returns:

(Array) —

Returns an array containing the linguistic tags for the tokenRanges within the receiving string.

- (`NSComparisonResult`) localizedCaseInsensitiveCompare(aString)

Returns an NSComparisonResult value that indicates the lexical ordering of the receiver and a given string using a case-insensitive, localized, comparison.

Parameters:

aString (String) —

The string with which to compare the receiver.This value must not be nil. If this value is nil, the behavior is undefined and may change in future versions of OS X.

Returns:

(NSComparisonResult) —

NSOrderedAscending the receiver precedes aString in lexical ordering, NSOrderedSame the receiver and aString are equivalent in lexical value, and NSOrderedDescending if the receiver follows aString.

- (`NSComparisonResult`) localizedCompare(aString)

Returns an NSComparisonResult value that indicates the lexical ordering of the receiver and another given string using a localized comparison.

Parameters:

aString (String) —

The string with which to compare the receiver.This value must not be nil. If this value is nil, the behavior is undefined and may change in future versions of OS X.

Returns:

(NSComparisonResult) —

NSOrderedAscending the receiver precedes string in lexical ordering, NSOrderedSame the receiver and string are equivalent in lexical value, and NSOrderedDescending if the receiver follows string.

- (`NSComparisonResult`) localizedStandardCompare(string)

Compares strings as sorted by the Finder. This method should be used whenever file names or other strings are presented in lists and tables where Finder-like sorting is appropriate. The exact sorting behavior of this method is different under different locales and may be changed in future releases.

Parameters:

string (String) —

The string to compare with the receiver.

Returns:

(NSComparisonResult) —

The result of the comparison.

- (`Integer`) longLongValue

Returns the long long value of the receiver’s text. This method uses formatting information stored in the non-localized value; use an NSScanner object for localized scanning of numeric values from a string.

Returns:

(Integer) —

The long long value of the receiver’s text, assuming a decimal representation and skipping whitespace at the beginning of the string. Returns LLONG_MAX or LLONG_MIN on overflow. Returns 0 if the receiver doesn’t begin with a valid decimal text representation of a number.

- (`String`) lowercaseString

Returns lowercased representation of the receiver. Case transformations aren’t guaranteed to be symmetrical or to produce strings of the same lengths as the originals. The result of this statement: might not be equal to this statement:For example, the uppercase form of “ß” in German is “SS”, so converting “Straße” to uppercase, then lowercase, produces this sequence of strings:“Straße”“STRASSE”“strasse”Note: This method performs the canonical (non-localized) mapping. It is suitable for programming operations that require stable results not depending on the user’s locale preference. For localized case mapping for strings presented to users, use the corresponding lowercaseStringWithLocale: method.

Returns:

(String) —

A string with each character from the receiver changed to its corresponding lowercase value.

- (`String`) lowercaseStringWithLocale(locale)

Returns lowercased representation of the receiver with the specified locale. For the user preference locale setting, pass the result of the NSLocale method currentLocale.

Parameters:

locale (NSLocale) —

The locale. Passing nil indicates the canonical mapping.

Returns:

(String) —

A lowercase string using the locale.

- (`Integer`) maximumLengthOfBytesUsingEncoding(enc)

Returns the maximum number of bytes needed to store the receiver in a given encoding. The result is an estimate and is returned in O(1) time; the estimate may be considerably greater than the actual length needed.

Parameters:

enc (NSStringEncoding) —

The encoding for which to determine the receiver's length.

Returns:

(Integer) —

The maximum number of bytes needed to store the receiver in encoding in a non-external representation. The length does not include space for a terminating NULL character. Returns 0 if the amount of memory required for storing the results of the encoding conversion would exceed NSIntegerMax.

- (`CLLocationCoordinate2D`) MKCoordinateForMapPoint(mapPoint)

Returns the latitude and longitude that corresponds to the specified map point.

Parameters:

mapPoint (MKMapPoint) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(CLLocationCoordinate2D) —

The coordinate structure containing the latitude and longitude values for the specified point.

- (`MKCoordinateRegion`) MKCoordinateRegionForMapRect(rect)

Returns the region that corresponds to the specified map rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(MKCoordinateRegion) —

The region structure specifying the latitude, longitude, and span values for the specified rectangle.

- (`UIKIT_STATIC_INLINE`) MKCoordinateRegionMake(centerCoordinate, span)

Creates a new MKCoordinateRegion from the specified coordinate and span values.

Parameters:

centerCoordinate (CLLocationCoordinate2D) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
span (MKCoordinateSpan) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(UIKIT_STATIC_INLINE) —

A region with the specified values.

- (`MKCoordinateRegion`) MKCoordinateRegionMakeWithDistance(centerCoordinate, latitudinalMeters, longitudinalMeters)

Creates a new MKCoordinateRegion from the specified coordinate and distance values.

Parameters:

centerCoordinate (CLLocationCoordinate2D) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
latitudinalMeters (CLLocationDistance) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.
longitudinalMeters (CLLocationDistance) —

The center point of the region.

Returns:

(MKCoordinateRegion) —

A region with the specified values.

- (`UIKIT_STATIC_INLINE`) MKCoordinateSpanMake(latitudeDelta, longitudeDelta)

Creates a new MKCoordinateSpan from the specified values.

Parameters:

latitudeDelta (CLLocationDegrees) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
longitudeDelta (CLLocationDegrees) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(UIKIT_STATIC_INLINE) —

A span with the specified delta values.

- (`Boolean`) MKMapPointEqualToPoint(point1, point2)

Returns a Boolean value indicating whether the two map points are equal.

Parameters:

point1 (MKMapPoint) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
point2 (MKMapPoint) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(Boolean) —

YES if the x and y values in both points are exactly the same or NO if one or both values are different.

- (`MKMapPoint`) MKMapPointForCoordinate(coordinate)

Returns the map point data structure that corresponds to the specified coordinate.

Parameters:

coordinate (CLLocationCoordinate2D) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(MKMapPoint) —

The map point value that corresponds to the specified coordinate on a two-dimensional map projection.

- (`MKMapPoint`) MKMapPointMake(x, y)

Creates a new MKMapPoint structure from the specified values.

Parameters:

x (Float) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
y (Float) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(MKMapPoint) —

A map point with the specified values.

- (`Float`) MKMapPointsPerMeterAtLatitude(latitude)

Returns the number of map points that represent one meter at the given latitude.

Parameters:

latitude (CLLocationDegrees) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The number of map points that span one meter.

- (`Boolean`) MKMapRectContainsPoint(rect, point)

Returns a Boolean value indicating whether the specified map point lies within the rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
point (MKMapPoint) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(Boolean) —

YES if the rectangle is not null or empty and the point is located inside the rectangle; otherwise, NO.

- (`Boolean`) MKMapRectContainsRect(rect1, rect2)

Returns Boolean value indicating whether one rectangle contains another.

Parameters:

rect1 (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
rect2 (MKMapRect) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(Boolean) —

YES if rect2 is null or lies entirely inside rect1; otherwise, returns NO if rect1 is null or does not completely enclose rect2.

- (`Object`) MKMapRectDivide(rect, slice, remainder, amount, edge)

Divides the specified rectangle into two smaller rectangles.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
slice (MKMapRect) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.
remainder (MKMapRect) —

The center point of the region.
amount (Float) —

The horizontal and vertical span representing the amount of map to display. The size of the span also reflects the current zoom level.
edge (CGRectEdge) —

The center point of the new coordinate region.

Returns:

(Object) —

YES if the rectangles are exactly the same or NO if the origin point or size values are different.

- (`Boolean`) MKMapRectEqualToRect(rect1, rect2)

Returns a Boolean value indicating whether the two map rectangles are equal

Parameters:

rect1 (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
rect2 (MKMapRect) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(Boolean) —

The rectangle’s height.

- (`Float`) MKMapRectGetHeight(rect)

Returns the height of the map rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The maximum x-axis value.

- (`Float`) MKMapRectGetMaxX(rect)

Returns the maximum x-axis value of the specified rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The maximum y-axis value.

- (`Float`) MKMapRectGetMaxY(rect)

Returns the maximum y-axis value of the specified rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The midpoint value along the x-axis.

- (`Float`) MKMapRectGetMidX(rect)

Returns the mid-point along the x-axis of the specified rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The midpoint value along the y-axis.

- (`Float`) MKMapRectGetMidY(rect)

Returns the mid-point along the y-axis of the specified rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The minimum x-axis value.

- (`Float`) MKMapRectGetMinX(rect)

Returns the minimum x-axis value of the specified rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The minimum y-axis value.

- (`Float`) MKMapRectGetMinY(rect)

Returns the minimum y-axis value of the specified rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The rectangle’s width.

- (`Float`) MKMapRectGetWidth(rect)

Returns the width of the map rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

The inset rectangle. If the original rectangle was null, that rectangle is returned instead.

- (`MKMapRect`) MKMapRectInset(rect, dx, dy)

Returns the specified rectangle inset by the specified amounts.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
dx (Float) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.
dy (Float) —

The center point of the region.

Returns:

(MKMapRect) —

The rectangle representing the intersection of the two rectangles or MKMapRectNull if there is no intersection.

- (`MKMapRect`) MKMapRectIntersection(rect1, rect2)

Returns the rectangle representing the intersection of two rectangles.

Parameters:

rect1 (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
rect2 (MKMapRect) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(MKMapRect) —

YES if rect1 and rect2 intersect each other or NO if they do not intersect or either rectangle is null.

- (`Boolean`) MKMapRectIntersectsRect(rect1, rect2)

Returns a Boolean value indicating whether two rectangles intersect each other.

Parameters:

rect1 (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
rect2 (MKMapRect) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(Boolean) —

YES if the rectangle is null or its width or height are equal to 0; otherwise, NO.

- (`Boolean`) MKMapRectIsEmpty(rect)

Returns a Boolean value indicating whether the specified rectangle has no area.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Boolean) —

YES if the rectangle is null or NO if it is not null.

- (`Boolean`) MKMapRectIsNull(rect)

Returns a Boolean indicating whether the specified rectangle is null.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Boolean) —

A map rectangle with the specified values.

- (`MKMapRect`) MKMapRectMake(x, y, width, height)

Creates a new MKMapRect structure from the specified values.

Parameters:

x (Float) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
y (Float) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.
width (Float) —

The center point of the region.
height (Float) —

The horizontal and vertical span representing the amount of map to display. The size of the span also reflects the current zoom level.

Returns:

(MKMapRect) —

The offset rectangle. If the original rectangle was null, that rectangle is returned instead.

- (`MKMapRect`) MKMapRectOffset(rect, dx, dy)

Returns a rectangle whose origin point is shifted by the specified amount.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
dx (Float) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.
dy (Float) —

The center point of the region.

Returns:

(MKMapRect) —

YES if the rectangle spans the 180th meridian or NO if it is contained wholly within the world map.

- (`MKMapRect`) MKMapRectRemainder(rect)

Normalizes the portion of the specified rectangle that lies outside the world map boundaries.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(MKMapRect) —

A rectangle whose area encompasses the two rectangles and the space between them.

- (`Boolean`) MKMapRectSpans180thMeridian(rect)

Returns a Boolean value that indicates whether the specified map rectangle crosses the 180th meridian.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Boolean) —

YES if the width and height values in both sizes are exactly the same or NO if one or both values are different.

- (`MKMapRect`) MKMapRectUnion(rect1, rect2)

Returns a rectangle representing the union of the two rectangles.

Parameters:

rect1 (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
rect2 (MKMapRect) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(MKMapRect) —

A map size with the specified values.

- (`Boolean`) MKMapSizeEqualToSize(size1, size2)

Returns a Boolean value indicating whether the two map sizes are equal.

Parameters:

size1 (MKMapSize) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
size2 (MKMapSize) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(Boolean) —

The number of meters between the specified map points.

- (`MKMapSize`) MKMapSizeMake(width, height)

Creates a new MKMapSize structure from the specified values.

Parameters:

width (Float) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
height (Float) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(MKMapSize) —

The distance (in meters) spanned by a single map point.

- (`CLLocationDistance`) MKMetersBetweenMapPoints(a, b)

Returns the number of meters between two map points.

Parameters:

a (MKMapPoint) —

The map point value that corresponds to the desired point on a two-dimensional map projection.
b (MKMapPoint) —

The map rectangle that corresponds to the desired region on a two-dimensional map projection.

Returns:

(CLLocationDistance) —

The width of roads, measured in screen points. You can use the returned value to set the width of lines in drawing code that traces the path of a road.

- (`CLLocationDistance`) MKMetersPerMapPointAtLatitude(latitude)

Returns the distance spanned by one map point at the specified latitude.

Parameters:

latitude (CLLocationDegrees) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(CLLocationDistance) —

A formatted string containing the x and y coordinates of the map point.

- (`Float`) MKRoadWidthAtZoomScale(zoomScale)

Returns the width (in screen points) of roads on a map at the specified zoom level.

Parameters:

zoomScale (MKZoomScale) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(Float) —

A formatted string containing the origin and size values of the map rectangle.

- (`String`) MKStringFromMapPoint(point)

Returns a formatted string for the specified map point.

Parameters:

point (MKMapPoint) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(String) —

A formatted string containing the width and height values of the map size.

- (`String`) MKStringFromMapRect(rect)

Returns a formatted string for the specified map rectangle.

Parameters:

rect (MKMapRect) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(String)

- (`String`) MKStringFromMapSize(size)

Returns a formatted string for the specified map size.

Parameters:

size (MKMapSize) —

The map point value that corresponds to the desired point on a two-dimensional map projection.

Returns:

(String)

- (`Object`) NSAllocateMemoryPages(bytes)

Allocates a new block of memory.

Parameters:

bytes (Integer) —

The class of which to create an instance.

Returns:

(Object) —

A new object that’s an exact copy of anObject, or nil if object is nil or if object could not be copied.

- (`Object`) NSAllocateObject(aClass, extraBytes, zone)

Creates and returns a new instance of a given class.

Parameters:

aClass (Class) —

The class of which to create an instance.
extraBytes (Integer) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
zone (NSZone) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(Object) —

A pointer to a new zone of startSize bytes, which will grow and shrink by granularity bytes. If canFree is 0, the allocator will never free memory, and malloc will be fast. Returns NULL if a new zone could not be created.

- (`Class`) NSClassFromString(aClassName)

Obtains a class by name.

Parameters:

aClassName (String) —

The class of which to create an instance.

Returns:

(Class) —

A range describing the intersection of range1 and range2—that is, a range containing the indices that exist in both ranges.

- (`NSSwappedDouble`) NSConvertHostDoubleToSwapped(x)

Performs a type conversion.

Parameters:

x (Float) —

The class of which to create an instance.

Returns:

(NSSwappedDouble) —

The result of invoking localizedStringForKey:value:table: on the main bundle and a nil table.

- (`NSSwappedFloat`) NSConvertHostFloatToSwapped(x)

Performs a type conversion.

Parameters:

x (Float) —

The class of which to create an instance.

Returns:

(NSSwappedFloat) —

The result of invoking localizedStringForKey:value:table: on the main bundle, passing it the specified key and tableName.

- (`Float`) NSConvertSwappedDoubleToHost(x)

Performs a type conversion.

Parameters:

x (NSSwappedDouble) —

The class of which to create an instance.

Returns:

(Float) —

The result of invoking localizedStringForKey:value:table: on bundle, passing it the specified key and tableName.

- (`Float`) NSConvertSwappedFloatToHost(x)

Performs a type conversion.

Parameters:

x (NSSwappedFloat) —

The class of which to create an instance.

Returns:

(Float) —

The result of invoking localizedStringForKey:value:table: on bundle, passing it the specified key, value, and tableName.

- (`Object`) NSCopyMemoryPages(source, dest, bytes)

Copies a block of memory.

Parameters:

source (Object) —

The class of which to create an instance.
dest (Object) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
bytes (Integer) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(Object) —

YES if loc lies within range—that is, if it’s greater than or equal to range.location and less than range.location plus range.length.

- (`Object`) NSCopyObject(object, extraBytes, zone)

Creates an exact copy of an object.

Parameters:

object (Object) —

The class of which to create an instance.
extraBytes (Integer) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
zone (NSZone) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(Object) —

The binary log of the page size.

- (`NSZone`) NSCreateZone(startSize, granularity, canFree)

Creates a new zone. (Deprecated. Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.)

Parameters:

startSize (Integer) —

The class of which to create an instance.
granularity (Integer) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
canFree (Boolean) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(NSZone) —

The sum of the location and length of the range—that is, range.location + range.length.

- (`Object`) NSDeallocateMemoryPages(ptr, bytes)

Deallocates the specified block of memory.

Parameters:

ptr (Object) —

The class of which to create an instance.
bytes (Integer) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(Object) —

A string identifying the root directory of the user’s system.

- (`Object`) NSDeallocateObject(object)

Destroys an existing object.

Parameters:

object (Object) —

The class of which to create an instance.

Returns:

(Object) —

The number of bytes in a page.

- (`NSCalculationError`) NSDecimalAdd(result, leftOperand, rightOperand, roundingMode)

Adds two decimal values.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
leftOperand (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
rightOperand (const NSDecimal) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(NSCalculationError) —

The protocol object named by namestr, or nil if no protocol by that name is currently loaded. If namestr is nil, returns nil.

- (`Object`) NSDecimalCompact(number)

Compacts the decimal structure for efficiency.

Parameters:

number (NSDecimal) —

The class of which to create an instance.

Returns:

(Object) —

The number of bytes available in RAM.

- (`NSComparisonResult`) NSDecimalCompare(leftOperand, rightOperand)

Compares two decimal values.

Parameters:

leftOperand (const NSDecimal) —

The class of which to create an instance.
rightOperand (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(NSComparisonResult) —

In bytes, the multiple of the page size that is closest to, but not greater than, byteCount (that is, the number of bytes rounded down to a multiple of the page size).

- (`Object`) NSDecimalCopy(destination, source)

Copies the value of a decimal number.

Parameters:

destination (NSDecimal) —

The class of which to create an instance.
source (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(Object) —

In bytes, the multiple of the page size that is closest to, but not less than, byteCount (that is, the number of bytes rounded up to a multiple of the page size).

- (`NSCalculationError`) NSDecimalDivide(result, leftOperand, rightOperand, roundingMode)

Divides one decimal value by another.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
leftOperand (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
rightOperand (const NSDecimal) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(NSCalculationError) —

The selector named by aSelectorName. If aSelectorName is nil, or cannot be converted to UTF-8 (this should be only due to insufficient memory), returns (SEL)0.

- (`Boolean`) NSDecimalIsNotANumber(dcm)

Returns a Boolean that indicates whether a given decimal contains a valid number.

Parameters:

dcm (const NSDecimal) —

The class of which to create an instance.

Returns:

(Boolean) —

Returns YES if requestedZone is NULL, the default zone, or the zone in which anObject was allocated; otherwise NO.

- (`NSCalculationError`) NSDecimalMultiply(result, leftOperand, rightOperand, roundingMode)

Multiplies two decimal numbers together.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
leftOperand (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
rightOperand (const NSDecimal) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(NSCalculationError) —

A string containing the name of aClass. If aClass is nil, returns nil.

- (`NSCalculationError`) NSDecimalMultiplyByPowerOf10(result, number, power, roundingMode)

Multiplies a decimal by the specified power of 10.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
number (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
power (Integer) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(NSCalculationError) —

A string containing the name of proto.

- (`NSCalculationError`) NSDecimalNormalize(number1, number2, roundingMode)

Normalizes the internal format of two decimal numbers to simplify later operations.

Parameters:

number1 (NSDecimal) —

The class of which to create an instance.
number2 (NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
roundingMode (NSRoundingMode) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(NSCalculationError) —

A string of the form “b”, where a and b are non-negative integers representing aRange.

- (`NSCalculationError`) NSDecimalPower(result, number, power, roundingMode)

Raises the decimal value to the specified power.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
number (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
power (Integer) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(NSCalculationError) —

A string representation of aSelector.

- (`Object`) NSDecimalRound(result, number, scale, roundingMode)

Rounds off the decimal value.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
number (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
scale (Integer) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(Object) —

A string containing the path of the temporary directory for the current user. If no such directory is currently available, returns nil.

- (`String`) NSDecimalString(dcm, locale)

Returns a string representation of the decimal value.

Parameters:

dcm (const NSDecimal) —

The class of which to create an instance.
locale (Object) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(String) —

A range covering all indices in and between range1 and range2. If one range is completely contained in the other, the returned range is equal to the larger range.

- (`NSCalculationError`) NSDecimalSubtract(result, leftOperand, rightOperand, roundingMode)

Subtracts one decimal value from another.

Parameters:

result (NSDecimal) —

The class of which to create an instance.
leftOperand (const NSDecimal) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
rightOperand (const NSDecimal) —

The zone in which to create the new instance (pass NULL to specify the default zone).
roundingMode (NSRoundingMode) —

An expression that evaluates to YES or NO.

Returns:

(NSCalculationError) —

The logon name of the current user.

- (`Boolean`) NSDecrementExtraRefCountWasZero(object)

Decrements the specified object’s reference count.

Parameters:

object (Object) —

The class of which to create an instance.

Returns:

(Boolean) —

The zone for the block of memory indicated by pointer, or NULL if the block was not allocated from a zone.

- (`NSZone`) NSDefaultMallocZone

Returns the default zone. (Deprecated. Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.)

Returns:

(NSZone) —

A string containing the name associated with zone. If zone is nil, the default zone is used. If no name is associated with zone, the returned string is empty.

- (`Boolean`) NSEqualRanges(range1, range2)

Returns a Boolean value that indicates whether two given ranges are equal.

Parameters:

range1 (NSRange) —

The class of which to create an instance.
range2 (NSRange) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(Boolean)

- (`Integer`) NSExtraRefCount(object)

Returns the specified object’s reference count.

Parameters:

object (Object) —

The class of which to create an instance.

Returns:

(Integer)

- (`String`) NSFullUserName

Returns a string containing the full name of the current user.

Returns:

(String)

- (`const`) NSGetSizeAndAlignment(typePtr, sizep, alignp)

Obtains the actual size and the aligned size of an encoded type.

Parameters:

typePtr (const char) —

The class of which to create an instance.
sizep (Integer) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
alignp (Integer) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(const)

- (`NSUncaughtExceptionHandler`) NSGetUncaughtExceptionHandler

Returns the top-level error handler.

Returns:

(NSUncaughtExceptionHandler)

- (`String`) NSHomeDirectory

Returns the path to either the user’s or application’s home directory, depending on the platform.

Returns:

(String)

- (`String`) NSHomeDirectoryForUser(userName)

Returns the path to a given user’s home directory.

Parameters:

userName (String) —

The class of which to create an instance.

Returns:

(String)

- (`Integer`) NSHostByteOrder

Returns the endian format.

Returns:

(Integer)

- (`nil`) NSIncrementExtraRefCount(object)

Increments the specified object’s reference count.

Parameters:

object (Object) —

The class of which to create an instance.

Returns:

(nil)

- (`NSRange`) NSIntersectionRange(range1, range2)

Returns the intersection of the specified ranges.

Parameters:

range1 (NSRange) —

The class of which to create an instance.
range2 (NSRange) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(NSRange)

- (`Boolean`) NSLocationInRange(loc, range)

Returns a Boolean value that indicates whether a specified position is in a given range.

Parameters:

loc (Integer) —

The class of which to create an instance.
range (NSRange) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(Boolean)

- (`nil`) NSLog(format)

Logs an error message to the Apple System Log facility.

Parameters:

format (String) —

The class of which to create an instance.

Returns:

(nil)

- (`Integer`) NSLogPageSize

Returns the binary log of the page size.

Returns:

(Integer)

- (`nil`) NSLogv(format, args)

Logs an error message to the Apple System Log facility.

Parameters:

format (String) —

The class of which to create an instance.
args (va_list) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(nil)

- (`NSRange`) NSMakeRange(loc, len)

Creates a new NSRange from the specified values.

Parameters:

loc (Integer) —

The class of which to create an instance.
len (Integer) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(NSRange)

- (`Integer`) NSMaxRange(range)

Returns the sum of the location and length of the range.

Parameters:

range (NSRange) —

The class of which to create an instance.

Returns:

(Integer)

- (`String`) NSOpenStepRootDirectory

Returns the root directory of the user’s system.

Returns:

(String)

- (`Integer`) NSPageSize

Returns the number of bytes in a page.

Returns:

(Integer)

- (`Protocol`) NSProtocolFromString(namestr)

Returns a the protocol with a given name.

Parameters:

namestr (String) —

The class of which to create an instance.

Returns:

(Protocol)

- (`NSRange`) NSRangeFromString(aString)

Returns a range from a textual representation.

Parameters:

aString (String) —

The class of which to create an instance.

Returns:

(NSRange)

- (`Integer`) NSRealMemoryAvailable

Returns information about the user’s system.

Returns:

(Integer)

- (`nil`) NSRecycleZone(zone)

Frees memory in a zone. (Deprecated. Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.)

Parameters:

zone (NSZone) —

The class of which to create an instance.

Returns:

(nil)

- (`Integer`) NSRoundDownToMultipleOfPageSize(bytes)

Returns the specified number of bytes rounded down to a multiple of the page size.

Parameters:

bytes (Integer) —

The class of which to create an instance.

Returns:

(Integer)

- (`Integer`) NSRoundUpToMultipleOfPageSize(bytes)

Returns the specified number of bytes rounded up to a multiple of the page size.

Parameters:

bytes (Integer) —

The class of which to create an instance.

Returns:

(Integer)

- (`Array`) NSSearchPathForDirectoriesInDomains(directory, domainMask, expandTilde)

Creates a list of directory search paths.

Parameters:

directory (NSSearchPathDirectory) —

The class of which to create an instance.
domainMask (NSSearchPathDomainMask) —

The number of extra bytes required for indexed instance variables (this value is typically 0).
expandTilde (Boolean) —

The zone in which to create the new instance (pass NULL to specify the default zone).

Returns:

(Array)

- (`Symbol`) NSSelectorFromString(aSelectorName)

Returns the selector with a given name.

Parameters:

aSelectorName (String) —

The class of which to create an instance.

Returns:

(Symbol)

- (`nil`) NSSetUncaughtExceptionHandler

Changes the top-level error handler.

Parameters:

The (NSUncaughtExceptionHandler) —

class of which to create an instance.

Returns:

(nil)

- (`nil`) NSSetZoneName(zone, name)

Sets the name of the specified zone. (Deprecated. Zones are ignored on iOS and 64-bit runtime on OS X. You should not use zones in current development.)

Parameters:

zone (NSZone) —

The class of which to create an instance.
name (String) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(nil)

- (`Boolean`) NSShouldRetainWithZone(anObject, requestedZone)

Indicates whether an object should be retained.

Parameters:

anObject (Object) —

The class of which to create an instance.
requestedZone (NSZone) —

The number of extra bytes required for indexed instance variables (this value is typically 0).

Returns:

(Boolean)

- (`String`) NSStringFromCGAffineTransform(transform)

Returns a string formatted to contain the data from an affine transform.

Parameters:

transform (CGAffineTransform) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(String) —

A string that corresponds to transform. See CGAffineTransformFromString for a discussion of the string format.

- (`String`) NSStringFromCGPoint(point)

Returns a string formatted to contain the data from a point.

Parameters:

point (CGPoint) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(String) —

A string that corresponds to point. See CGPointFromString for a discussion of the string format.

- (`String`) NSStringFromCGRect(rect)

Returns a string formatted to contain the data from a rectangle.

Parameters:

rect (CGRect) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(String) —

A string that corresponds to rect. See CGRectFromString for a discussion of the string format.

- (`String`) NSStringFromCGSize(size)

Returns a string formatted to contain the data from a size data structure.

Parameters:

size (CGSize) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(String) —

A string that corresponds to size. See CGSizeFromString for a discussion of the string format.

- (`String`) NSStringFromClass(aClass)

Returns the name of a class as a string.

Parameters:

aClass (Class) —

The class of which to create an instance.

Returns:

(String)

- (`String`) NSStringFromProtocol(proto)

Returns the name of a protocol as a string.

Parameters:

proto (Protocol) —

The class of which to create an instance.

Returns:

(String)

- (`String`) NSStringFromRange(range)

Returns a string representation of a range.

Parameters:

range (NSRange) —

The class of which to create an instance.

Returns:

(String)

- (`String`) NSStringFromSelector(aSelector)

Returns a string representation of a given selector.

Parameters:

aSelector (Symbol) —

The class of which to create an instance.

Returns:

(String)

- (`String`) NSStringFromUIEdgeInsets(insets)

Returns a string formatted to contain the data from an edge insets structure.

Parameters:

insets (UIEdgeInsets) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(String) —

A string that corresponds to insets. See UIEdgeInsetsFromString for a discussion of the string format.

- (`String`) NSStringFromUIOffset(offset)

Returns a string formatted to contain the data from an offset structure.

Parameters:

offset (UIOffset) —

A string whose contents are of the form “b, c, d, tx, ty”, where a, b, c, d, tx, and ty are the floating-point component values of the CGAffineTransform data structure. An example of a valid string is @”1,0,0,1,21,0,0,1,2.5,31,0,0,1,2.5,3.0”. The string is not localized, so items are always separated with a comma. For information about the position of each value in the transform array, see CGAffineTransform Reference.

Returns:

(String) —

A string that corresponds to offset.