Aliases.h

Go to the documentation of this file.

 
#ifndef __ALIASES__
#define __ALIASES__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
  enum
  {
    rAliasType =
        FOUR_CHAR_CODE('alis') 
  };
 
  enum
  {
    kARMMountVol = 0x00000001,      
    kARMNoUI = 0x00000002,          
    kARMMultVols = 0x00000008,      
    kARMSearch = 0x00000100,        
    kARMSearchMore = 0x00000200,    
    kARMSearchRelFirst = 0x00000400 
  };
 
  enum
  {
    asiZoneName = -3,   
    asiServerName = -2, 
    asiVolumeName = -1, 
    asiAliasName = 0,   
    asiParentName = 1   
  };
 
  enum
  {
    kResolveAliasFileNoUI =
        0x00000001 
  };
 
  struct AliasRecord
  {
    OSType userType;          
    unsigned short aliasSize; 
  };
  typedef struct AliasRecord AliasRecord;
  typedef AliasRecord *AliasPtr;
  typedef AliasPtr *AliasHandle;
  typedef short AliasInfoType;
  OSErr
  NewAlias(const FSSpec *fromFile, 
           const FSSpec *target, AliasHandle *alias);
 
  OSErr
  NewAliasMinimal(const FSSpec *target, AliasHandle *alias);
 
  OSErr
  NewAliasMinimalFromFullPath(short fullPathLength, const void *fullPath,
                              ConstStr32Param zoneName,
                              ConstStr31Param serverName, AliasHandle *alias);
 
  OSErr
  ResolveAlias(const FSSpec *fromFile, 
               AliasHandle alias, FSSpec *target, Boolean *wasChanged);
 
  OSErr
  GetAliasInfo(AliasHandle alias, AliasInfoType index, Str63 theString);
 
  OSErr
  IsAliasFile(const FSSpec *fileFSSpec, Boolean *aliasFileFlag,
              Boolean *folderFlag);
 
  OSErr
  ResolveAliasWithMountFlags(const FSSpec *fromFile, 
                             AliasHandle alias, FSSpec *target,
                             Boolean *wasChanged, unsigned long mountFlags);
 
  OSErr
  ResolveAliasFile(FSSpec *theSpec, Boolean resolveAliasChains,
                   Boolean *targetIsFolder, Boolean *wasAliased);
 
  OSErr
  ResolveAliasFileWithMountFlags(FSSpec *theSpec, Boolean resolveAliasChains,
                                 Boolean *targetIsFolder, Boolean *wasAliased,
                                 unsigned long mountFlags);
 
  OSErr
  FollowFinderAlias(const FSSpec *fromFile, 
                    AliasHandle alias, Boolean logon, FSSpec *target,
                    Boolean *wasChanged);
 
  OSErr
  UpdateAlias(const FSSpec *fromFile, 
              const FSSpec *target, AliasHandle alias, Boolean *wasChanged);
 
  typedef CALLBACK_API(Boolean, AliasFilterProcPtr)(CInfoPBPtr cpbPtr,
                                                    Boolean *quitFlag,
                                                    Ptr myDataPtr);
  typedef STACK_UPP_TYPE(AliasFilterProcPtr) AliasFilterUPP;
  AliasFilterUPP
  NewAliasFilterUPP(AliasFilterProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppAliasFilterProcInfo = 0x00000FD0
  }; 
#ifdef __cplusplus
  inline AliasFilterUPP NewAliasFilterUPP(AliasFilterProcPtr userRoutine)
  {
    return (AliasFilterUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppAliasFilterProcInfo, GetCurrentArchitecture());
  }
#else
#define NewAliasFilterUPP(userRoutine)                                     \
  (AliasFilterUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppAliasFilterProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeAliasFilterUPP(AliasFilterUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeAliasFilterUPP(AliasFilterUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeAliasFilterUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  Boolean
  InvokeAliasFilterUPP(CInfoPBPtr cpbPtr, Boolean *quitFlag, Ptr myDataPtr,
                       AliasFilterUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline Boolean InvokeAliasFilterUPP(CInfoPBPtr cpbPtr, Boolean *quitFlag,
                                      Ptr myDataPtr, AliasFilterUPP userUPP)
  {
    return (Boolean)CALL_THREE_PARAMETER_UPP(userUPP, uppAliasFilterProcInfo,
                                             cpbPtr, quitFlag, myDataPtr);
  }
#else
#define InvokeAliasFilterUPP(cpbPtr, quitFlag, myDataPtr, userUPP)      \
  (Boolean) CALL_THREE_PARAMETER_UPP((userUPP), uppAliasFilterProcInfo, \
                                     (cpbPtr), (quitFlag), (myDataPtr))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewAliasFilterProc(userRoutine) NewAliasFilterUPP(userRoutine)
#define CallAliasFilterProc(userRoutine, cpbPtr, quitFlag, myDataPtr) \
  InvokeAliasFilterUPP(cpbPtr, quitFlag, myDataPtr, userRoutine)
#endif 
  OSErr
  MatchAlias(const FSSpec *fromFile, 
             unsigned long rulesMask, AliasHandle alias, short *aliasCount,
             FSSpecArrayPtr aliasList, Boolean *needsUpdate,
             AliasFilterUPP aliasFilter, void *yourDataPtr);
 
  OSErr
  ResolveAliasFileWithMountFlagsNoUI(FSSpec *theSpec, Boolean resolveAliasChains,
                                     Boolean *targetIsFolder, Boolean *wasAliased,
                                     unsigned long mountFlags);
 
  OSErr
  MatchAliasNoUI(const FSSpec *fromFile, 
                 unsigned long rulesMask, AliasHandle alias, short *aliasCount,
                 FSSpecArrayPtr aliasList, Boolean *needsUpdate,
                 AliasFilterUPP aliasFilter, void *yourDataPtr);
 
  OSErr
  FSNewAlias(const FSRef *fromFile, 
             const FSRef *target, AliasHandle *inAlias);
 
  OSErr
  FSNewAliasMinimal(const FSRef *target, AliasHandle *inAlias);
 
  OSErr
  FSIsAliasFile(const FSRef *fileRef, Boolean *aliasFileFlag, Boolean *folderFlag);
 
  OSErr
  FSResolveAliasWithMountFlags(const FSRef *fromFile, 
                               AliasHandle inAlias, FSRef *target,
                               Boolean *wasChanged, unsigned long mountFlags);
 
  OSErr
  FSResolveAlias(const FSRef *fromFile, 
                 AliasHandle alias, FSRef *target, Boolean *wasChanged);
 
  OSErr
  FSResolveAliasFileWithMountFlags(FSRef *theRef, Boolean resolveAliasChains,
                                   Boolean *targetIsFolder, Boolean *wasAliased,
                                   unsigned long mountFlags);
 
  OSErr
  FSResolveAliasFile(FSRef *theRef, Boolean resolveAliasChains,
                     Boolean *targetIsFolder, Boolean *wasAliased);
 
  OSErr
  FSFollowFinderAlias(FSRef *fromFile, 
                      AliasHandle alias, Boolean logon, FSRef *target,
                      Boolean *wasChanged);
 
  OSErr
  FSUpdateAlias(const FSRef *fromFile, 
                const FSRef *target, AliasHandle alias, Boolean *wasChanged);
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif 
* /