Carbon


InvalidateFolderDescriptorCache

Header: Folders.h Carbon status: Supported

Invalidates any prior FindFolder results for the specified folder.

OSErr InvalidateFolderDescriptorCache (
    SInt16 vRefNum, 
    SInt32 dirID
);
Parameter descriptions
vRefNum

Pass the volume reference number (or the constant kOnSystemDisk for the startup disk) of the volume containing the folder for which you wish the descriptor cache to be invalidated. Pass 0 to completely invalidate all folder cache information.

dirID

Pass the directory ID number for the folder for which you wish the descriptor cache to be invalidated. Pass 0 to invalidate the cache for all folders on the specified disk.

function result

A result code.

DISCUSSION

The InvalidateFolderDescriptorCache function searches to see if there is currently a cache of results from FindFolder calls on the specified folder. If so, it invalidates the cache from the previous calls to the FindFolder function in order to force the Folder Manager to reexamine the disk when FindFolder is called again on the specified directory ID or volume reference number.

You should not normally need to call InvalidateFolderDescriptorCache.

VERSION NOTES

This function is supported under Mac OS 8 and later.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)