![]() |
PBGetCatalogInfoBulkSync |
||||
Header: | Files.h | Carbon status: | Supported | |
Returns information about one or more objects from a catalog iterator; it can return information about multiple objects in a single call.
OSErr PBGetCatalogInfoBulkSync ( FSCatalogBulkParam *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. When all of the iterators objects have been returned, the call will return errFSNoMoreItems. The PBGetCatalogInfoBulkSync call may complete and return noErr with fewer than maximumObjects items returned. This may be due to various reasons related to the internal implementation. In this case, you may continue to make PBGetCatalogInfoBulkSync calls using the same iterator.
On input, the iterator to use.
On input, the maximum number of items to return.
On output, the actual number of items found for this call.
On output, a value indicating whether or not the containers contents have changed since the previous PBGetCatalogInfoBulkSync call. If set to true, the contents have changed. This output is optional; if you dont want it, pass a NULL pointer. Note that if the container has changed, then the total set of items returned may be incorrect; some items may be returned multiple times, and some items may not be returned at all.
On input, the catalog information fields to return for each item.
On output, an array of catalog information structures; one for each returned item. The catalogInfos field should point to an array of maximumObjects FSCatalogInfos. See also FSCatalogInfo.
On output, an array of FSRefs; one for each returned item. If you want an FSRef for each item found, set this field to point to an array of maximumObjects FSRefs. Otherwise, set it to NULL.
On output, an array of filenames; one for each returned item. If you want the Unicode filename for each item found, set this field to point to an array of maximumObjects HFSUniStr255s. Otherwise, set it to NULL.
The last four fields allow you to obtain the FSRef, Unicode name, and catalog information for every item found. If you dont want any catalog information, set whichInfo to kFSCatInfoNone and catalogInfos to NULL.
Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 9, or later.
© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)