Allias Suite

Allows plug-ins to create aliases. More...

Data Structures

struct  PSAliasSuite
 The set of routines available in the Alias Suite. More...

Defines

#define kPSAliasSuite   "Photoshop Alias Utility Suite"
 Unique identifier for the Alias Suite.
#define kPSAliasSuiteVersion1   1
 Current version of the Alias Suite.

Typedefs

typedef SPAPI SPErr(*) MacNewAliasFromCStringProc (const char *cStringPathToFile, AliasHandle *alias)
 Makes a new Mac OS alias from a C String.
typedef SPAPI SPErr(*) MacNewAliasFromFSRefProc (const void *fsRefToFile, AliasHandle *alias)
 Makes a new Mac OS alias from a file specification reference.
typedef SPAPI SPErr(*) MacNewAliasFromNameAndFSRefProc (const void *cfStringFilename, const void *fsRefToParentDir, AliasHandle *alias)
 Makes a new Mac OS alias from a file specification directory reference and a C String.
typedef SPAPI SPErr(*) WinNewAliasFromWidePathProc (const uint16 *filePathAsUTF16, AliasHandle *alias)
 Makes a new Windows alias from a Unicode string path.
typedef SPAPI SPErr(*) WinNewAliasFromPIDLProc (const void *pidlToFile, AliasHandle *alias)
 Makes a new Windows alias from a PIDL.

Detailed Description

Allows plug-ins to create aliases.

Accessing the Suite

The Alias suite is referred to as:

  #define kPSAliasSuite             "Photoshop Alias Utility Suite"
The current version of the Alias suite:
  #define kPSAliasSuiteVersion1     1
The suite is acquired as follows:
  PSAliasSuite *sPSAlias;
  error = sSPBasic->AcquireSuite(kPSAliasSuite,
                                 kPSAliasSuiteVersion1,       
                                 &sPSAlias);
  if (error) goto . . . //handle error
For PICA errors, see SPErrorCodes.h.

Define Documentation

#define kPSAliasSuite   "Photoshop Alias Utility Suite"

Unique identifier for the Alias Suite.

#define kPSAliasSuiteVersion1   1

Current version of the Alias Suite.


Typedef Documentation

typedef SPAPI SPErr(*) MacNewAliasFromCStringProc(const char *cStringPathToFile, AliasHandle *alias)

Makes a new Mac OS alias from a C String.

Parameters:
cStringPathToFile The C string from which to make an alias.
alias [OUT] The alias, returned.
Returns:
Non-zero error if failure.

typedef SPAPI SPErr(*) MacNewAliasFromFSRefProc(const void *fsRefToFile, AliasHandle *alias)

Makes a new Mac OS alias from a file specification reference.

Parameters:
fsRefToFile The file specification reference from which to make an alias.
alias [OUT] The alias, returned.
Returns:
Non-zero error if failure.

typedef SPAPI SPErr(*) MacNewAliasFromNameAndFSRefProc(const void *cfStringFilename, const void *fsRefToParentDir, AliasHandle *alias)

Makes a new Mac OS alias from a file specification directory reference and a C String.

Parameters:
cStringPathToFile The C string from which to make an alias. This is the file name.
fsRefToParentDir The file specification directory reference from which to make an alias. This is the path to the file.
alias [OUT] The alias, returned.
Returns:
Non-zero error if failure.

typedef SPAPI SPErr(*) WinNewAliasFromWidePathProc(const uint16 *filePathAsUTF16, AliasHandle *alias)

Makes a new Windows alias from a Unicode string path.

Parameters:
filePathAsUTF16 The file path encoded in UTF16.
alias [OUT] The alias, returned.
Returns:
Non-zero error if failure.

typedef SPAPI SPErr(*) WinNewAliasFromPIDLProc(const void *pidlToFile, AliasHandle *alias)

Makes a new Windows alias from a PIDL.

Parameters:
pidlToFile 
alias [OUT] The alias, returned.
Returns:
Non-zero error if failure.