Legacy Document

Inside Macintosh: Files /

Chapter 4 - Alias Manager / Alias Manager Reference

Application-Defined Routines / Filtering Possible Targets

MyMatchAliasFilter

You can pass the address of an alias-matching filter function to the MatchAlias function.

FUNCTION MyMatchAliasFilter (cpbPtr: CInfoPBPtr; 
                              VAR quitFlag: Boolean; 
                              myDataPtr: Ptr): Boolean;

cpbPtr

A pointer to a catalog information parameter block.

quitFlag

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

myDataPtr

A pointer to custom data.

DESCRIPTION

Your application-defined filter function is called by MatchAlias to filter out possible matches. 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 NIL if it
is calling your function to give it the periodic chance to terminate the search. (Do not
use this pointer without checking for NIL.) If you want to terminate the search, set the quitFlag parameter to TRUE.

The myDataPtr parameter points 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.

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.