On Mar 13, 2007, at 13:53:45, Laurence Harris wrote:
The documentation for the actual struct usually provides more
detail. When a struct is used in multiple APIs, as this one is, I
look to the API documentation for information specific to the use
of the struct in that specific API, as different APIs may use
different fields or expect different information in a field. But
for general information about the fields in a struct I look at the
documentation for the struct. In this case, all APIs that take a
FSRefParam accept NULL for ioNamePtr.
Hopefully they'll fix that, because when I want to know how a
specific function works, I look at *its* docs and don't think it
makes sense to force the user to go hunting all over the place.
I haven't found hope to be particularly effect. Did you file a
documentation request in Radar?
And especially when there is a conflicting information like this,
how does the user know which is correct? I assume the function's
docs are more correct because the function is the one using the
struct.
The documentation for the function doesn't say ioNamePtr cannot be
NULL, so there isn't a conflict. In most cases, ioNamePtr has limited
use at best in an FSRef function because it's a StringPtr. I'm kind
of surprised these APIs even have an option for an StringPtr. FWIW,
using NULL for the ioNamePtr field in various File Manager parameter
blocks has always been allowed to the best of my recollection as long
as the parameter wasn't needed.
Larry
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Carbon-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
http://lists.apple.com/mailman/options/carbon-dev/email@hidden
