CFErrorCopyRecoverySuggestion(_:)
Returns a human presentable recovery suggestion for a given error.
Declaration
func CFErrorCopyRecoverySuggestion(_ err: CFError!) -> CFString!Parameters
- err:
The CFError to examine. If this is not a valid CFError, the behavior is undefined.
Return Value
A localized, human-presentable recovery suggestion for err, or NULL if no user-presentable string is available. Ownership follows the The Create Rule.
Discussion
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 kCFErrorLocalizedRecoverySuggestionKey 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 kCFErrorLocalizedRecoverySuggestionKey in the user info dictionary.