![]() |
PBGetCatalogInfoSync |
||||
Header: | Files.h | Carbon status: | Supported | |
Returns general information about a file or directory.
OSErr PBGetCatalogInfoSync ( FSRefParam *paramBlock );
A pointer to a parameter block
A result code.
The relevant fields of the parameter block are:
On input, a pointer to a completion routine.
On output, the result code of the function.
On input, the file or directory whose information is to be returned.
On input, which catalog info fields to get. This field is optional; if you do not wish to retrieve this information set whichInfo to NULL.
On output, an FSCatalogInfo structure containing the general information about the file or directory. Only the information specified by whichInfo is returned. If you dont want any catalog info, set catalogInfo to NULL.
On output, the FSSpec for the object. This field is optional; if you do not wish to receive this value, set spec to NULL.
On output, a pointer to the FSRef for the object's parent directory. This field is optional; if you do not wish to receive this value, set parentRef to NULL.
If the object specified by ref is a volumes root directory, then the ref returned in parentRef will not be a valid FSRef (since the root directory has no parent object).
On output, the file or directory Unicode name is returned here. This field is optional; if you do not wish to receive this value, set outName to NULL.
Supported in Carbon. Available in Mac OS 9, and later when Carbon 1.0.2 or later is present.
© 2000 Apple Computer, Inc. (Last Updated 5/8/2000)