Incomplete Parameter Description in Search Kit reference

Originator:timschroedernet
Number:rdar://11684155 Date Originated:15-Jun 2012
Status:open Resolved:
Product:OS X Product Version:10.7.4
Classification:Other Bug Reproducible:n/a
 
Summary: The documentation of the SKIndexOpenWithURL function in the Search Kit Reference (https://developer.apple.com/library/mac/#documentation/UserExperience/Reference/SearchKit/Reference/reference.html) is incomplete and therefore misleading.

Steps to Reproduce: n/a

Expected Results: The documentation of the inIndexName parameter of the SKIndexOpenWithURL function should read "The name of the index. Can be NULL, in which case this function attempts to open the index with the default name of IADefaultIndex."

Actual Results: The documentation of the inIndexName parameter of the SKIndexOpenWithURL function reads "The name of the index. Can be NULL."

Regression: n/a

Notes: If no index name is provided when opening an existing search index (and the parameter inIndexName is set to NULL), the Search Kit Framework will try to open an index with the default name of IADefaultIndex. If it doesn't find an index with this name, it will return NULL. This is correctly stated in the documentation of the SKIndexOpenWithData function and in the documentation of the SKIndexOpenWithMutableData function, but is missing in the documentation of the SKIndexOpenWithURL function.

Comments


Please note: Reports posted here will not necessarily be seen by Apple. All problems should be submitted at bugreport.apple.com before they are posted here. Please only post information for Radars that you have filed yourself, and please do not include Apple confidential information in your posts. Thank you!