Type Alias

FSAliasFilterProcPtr

Defines a pointer to an alias filtering callback function that filters out possible targets identified by the FSMatchAliasBulk function.

Declaration

typedef Boolean (*FSAliasFilterProcPtr)(const FSRef *ref, Boolean *quitFlag, Ptr myDataPtr);

Parameters

ref

A pointer to a file system object. When your function is called, the ref parameter points to the possible match.

quitFlag

On output, set this Boolean flag to true if you want to terminate the search.

myDataPtr

A pointer to any customized data that your application passed when it called FSMatchAliasBulk. This parameter allows your filter function to access any data that your application has set up on its own.

Return Value

Your function should return true to indicate that the possible match is to be discarded, or false to indicate that the possible match is to be added to the list of possible targets.

Discussion

You can write your own filter function to examine possible targets identified by the FSMatchAliasBulk function. The FSMatchAliasBulk function calls your filter function each time it identifies a possible match.