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

typedef Boolean(* AliasFilterProcPtr) (
    CInfoPBPtr cpbPtr, 
    Boolean *quitFlag, 
    Ptr myDataPtr
);

You would declare your function like this if you were to name it MyAliasFilterCallback:

Boolean MyAliasFilterCallback (
    CInfoPBPtr cpbPtr, 
    Boolean *quitFlag, 
    Ptr myDataPtr
);

cpbPtr

A pointer to a catalog information parameter block. When your function is called, the cpbPtr parameter points to the catalog information parameter block of the possible match (returned by the File Manager function PBGetCatInfo). The MatchAlias function sets this parameter to NULL if it is calling your function to give it the periodic chance to terminate the search. (Do not use this pointer without checking for NULL.)

quitFlag

On exit, set this to true if you want to terminate the search.

myDataPtr

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

function result

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.0

DISCUSSION

You can write your own filter function to examine possible targets identified by the MatchAlias function. The MatchAlias function calls your filter function each time it identifies a possible match or when three seconds have elapsed without a match.

AVAILABILITY

Supported in Carbon.

© 2000 Apple Computer, Inc. — (Last Updated 4/4/2000)