Returns a human presentable recovery suggestion for a given error.
- iOS 2.0+
- macOS 10.5+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
- Core Foundation
The CFError to examine. If this is not a valid CFError, the behavior is undefined.
A localized, human-presentable recovery suggestion for
NULL if no user-presentable string is available. Ownership follows the The Create Rule.
This is the string that can be displayed as the “informative” (or “secondary”) message on an alert panel. For example, an error description “Could not save file ‘Letter’ in folder ‘Documents’ because the volume ‘MyDisk’ doesn’t have enough space.“ might have a corresponding recovery suggestion, “Remove some files from the volume and try again.“
By default, this function looks for a value for the
k key in the user info dictionary. Toll-free bridged instances of
NSError might provide additional behaviors for manufacturing this value.
When you create a CFError, you should try to make sure the return value is human-presentable and localized by providing a value for
k in the user info dictionary.