Main Page Cookbook/Overview ImageMeister the jcprops file Licensing Please Vote! Binary Installation & Configuration [ Win · Mac · Nix ] Changes Public API Source Code Main Page Java [ Common · Win · Mac · Nix ] Native Code [ Common · Win · Mac · Nix ] Manifest Native Code Overviews [ Common · Win · Mac · Nix · Strings ] Macros [ General · Native Macros ] Walkthroughs [ Java only · Java and native ] Building [ Win · Mac · Nix ] Distribution Issues

# SAliases

  Used to create and resolve aliases.

[ Mac | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

## Quick Index

  DESCRIPTION

## Class Summary

class SAliases
{
public:

  typedef enum tageFileCategory eFileCategory;
  typedef enum tageAliasInteraction eAliasInteraction;
  static ErrCode getFileCategory( const CFSpec *theSpec, eFileCategory *category );
  static ErrCode createAlias( const CFSpec *targetSpec, const CStr *csNewAliasPath, long creator, long flags );
  static ErrCode createVolumeAlias( long targetVRef, const CStr *csNewAliasPath, long creator, long flags );
  static ErrCode resolveAnAlias( const CFSpec *inSpec, CFSpec *outSpec, tageAliasInteraction flags );

protected:

}; // SAliases

Back to the top of SAliases

### DESCRIPTION

Used to create and resolve aliases.

Back to the top of SAliases

### typedef enum tageFileCategory eFileCategory;

getFileCategory() returns one of these values.

    	typedef enum tageFileCategory {
    		kCategoryVolume = 0,
    		kCategoryDirectory = 1,
    		kCategoryFile = 2,
    		kCategoryAlias = 3,
    		kCategoryUnknown = 4
    	} eFileCategory;

Back to the top of SAliases

### typedef enum tageAliasInteraction eAliasInteraction;

Indicates whether resolving an alias should cause interaction with the user.

    	typedef enum tageAliasInteraction {
    		kResolveAliasNoUI = 1,
    		kResolveAliasUI = 2
    	} eAliasInteraction;

Back to the top of SAliases

### ErrCode getFileCategory( const CFSpec *theSpec, eFileCategory *category );

Get the type ( alias, volume, etc. ) of a disk object. One of the eFileCategory values will be placed in 'category'

in theSpec
  the file/folder/volume
out category
  on return, will contain the category of 'theSpec'

    	static	ErrCode getFileCategory( const CFSpec *theSpec, eFileCategory *category );

Back to the top of SAliases

### ErrCode createAlias( const CFSpec *targetSpec, const CStr *csNewAliasPath, long creator, long flags );

Create an alias to a file or folder.

in targetSpec
  the target of the new alias
in csNewAliasPath
  the full path of the new alias file
in creator
  ignored
in flags
  ignored

    	static	ErrCode createAlias( const CFSpec *targetSpec, const CStr *csNewAliasPath,
    								long creator, long flags );

Back to the top of SAliases

### ErrCode createVolumeAlias( long targetVRef, const CStr *csNewAliasPath, long creator, long flags );

Create an alias to a volume.

in targetVRef
  the vRefNum of the target
in csNewAliasPath
  the full path of the new alias file
in creator
  ignored
in flags
  ignored

    	static	ErrCode createVolumeAlias( long targetVRef, const CStr *csNewAliasPath,
    									long creator, long flags );

Back to the top of SAliases

### ErrCode resolveAnAlias( const CFSpec *inSpec, CFSpec *outSpec, tageAliasInteraction flags );

Resolve an alias.

in inSpec
  the alias to resolve
out outSpec
  on return, contains the resolved file
in flags
  one of the eAliasInteraction values

    	static	ErrCode resolveAnAlias( const CFSpec *inSpec, CFSpec *outSpec,
    									tageAliasInteraction flags );

Back to the top of SAliases

## All Members

public:
  typedef enum tageFileCategory eFileCategory;
  typedef enum tageAliasInteraction eAliasInteraction;
  static ErrCode getFileCategory( const CFSpec *theSpec, eFileCategory *category );
  static ErrCode createAlias( const CFSpec *targetSpec, const CStr *csNewAliasPath, long creator, long flags );
  static ErrCode createVolumeAlias( long targetVRef, const CStr *csNewAliasPath, long creator, long flags );
  static ErrCode resolveAnAlias( const CFSpec *inSpec, CFSpec *outSpec, tageAliasInteraction flags );
protected:

Back to the top of SAliases

## Ancestors

Class does not inherit from any other class.

Back to the top of SAliases

## Descendants

Class is not inherited by any others.

Back to the top of SAliases

Generated from source by the Cocoon utilities on Mon May 28 10:11:09 2001 .

Main Page · JConfig · ImageMeister · System Properties Repository · WordMeister · Free Samples · Java Freeware · Contact Us · FAQ · Links

Copyright (c) 1997,1998,1999,2000 Samizdat Productions. All Rights Reserved.
WarpMovie, TileMovie, JConfig, ImageMeister and MovieShredder are Trademarks of Samizdat Productions.