Carbon


FSGetCatalogInfoBulk

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 FSGetCatalogInfoBulk (
    FSIterator iterator, 
    ItemCount maximumObjects, 
    ItemCount *actualObjects, 
    Boolean *containerChanged, 
    FSCatalogInfoBitmap whichInfo, 
    FSCatalogInfo *catalogInfos, 
    FSRef *refs, 
    FSSpec *specs, 
    HFSUniStr255 *names
);
iterator

The iterator to use.

maximumObjects

The maximum number of items to return.

actualObjects

On return, a pointer to the actual number of items found for this call.

containerChanged

On return, a pointer to a value indicating whether or not the container’s contents have changed since the previous FSGetCatalogInfoBulk call. If set to true, the contents have changed. This output is optional; if you don’t 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.

whichInfo

The catalog information fields to return for each item.

catalogInfos

A pointer to an array of catalog information structures; one for each returned item. The catalogInfos parameter should point to an array of maximumObjects FSCatalogInfos. See also FSCatalogInfo.

refs

A pointer to an array of FSRefs; one for each returned item. If you want an FSRef for each item found, set this parameter to point to an array of maximumObjects FSRefs. Otherwise, set it to NULL.

specs

A pointer to an array of filenames; one for each returned item. If you want the Unicode filename for each item found, set this parameter to point to an array of maximumObjects HFSUniStr255s. Otherwise, set it to NULL.

names
function result

A result code. When all of the iterator’s objects have been returned, the call will return errFSNoMoreItems. The FSGetCatalogInfoBulk 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 FSGetCatalogInfoBulk calls using the same iterator.

DISCUSSION

The last four parameters allow you to obtain the FSRef, Unicode name, and catalog information for every item found. If you don’t want any catalog information, set whichInfo to kFSCatInfoNone and catalogInfos to NULL.

AVAILABILITY

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)