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

Data Structures
struct	PSAliasSuite1
	The set of routines available in the Alias Suite. More...
struct	PSAliasSuite2
Defines
#define	kPSAliasSuite "Photoshop Alias Utility Suite"
	Unique identifier for the Alias Suite.
#define	kPSAliasSuiteVersion1 1
	Current version of the Alias Suite.
#define	kPSAliasSuiteVersion2 2
#define	kPSAliasSuiteVersion kPSAliasSuiteVersion2
Typedefs
typedef SPAPI SPErr(*	MacNewAliasFromCStringProc )(const char cStringPathToFile, AliasHandle alias)
	NOTE that on the Mac, this suite should be considered deprecated as of Photoshop 17.0.
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.
typedef SPAPI SPErr(*	NewAliasFromCloudPathProc )(const char cloudPath, AliasHandle alias)
	Makes a new alias from a cloud document path.
typedef SPAPI SPErr(*	IsCloudFileProc )(AliasHandle alias, SPBoolean *isCloud)
	Used to query whether or not an alias is representing a cloud file.
typedef SPAPI SPErr(*	CloudReferenceFromAliasProc )(AliasHandle alias, ASZString *reference)
	Used to get the cloud asset reference for an alias that is related to a cloud file.
typedef SPAPI SPErr(*	CloudPathFromAliasProc )(AliasHandle alias, ASZString *reference)
	Used to get the cloud asset reference path for an alias that is related to a cloud file.
typedef SPAPI SPErr(*	NewAliasFromCloudReferenceProc )(const char reference, AliasHandle alias)
	Used to create an alias from a cloud asset reference.
typedef SPAPI SPErr(*	UnicodePathToAliasProc )(const uint16 unicodePath, AliasHandle alias)
	Used to create an alias from a unicode path.
typedef SPAPI SPErr(*	AliasToUnicodePathProc )(const AliasHandle alias, uint16 *unicodePath, uint32 length)
	Used to create a unicode path from an alias.
typedef PSAliasSuite2	PSAliasSuite

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 kPSAliasSuiteVersion      kPSAliasSuiteVersion2

The suite is acquired as follows:

  PSAliasSuite *sPSAlias;
  error = sSPBasic->AcquireSuite(kPSAliasSuite,
                                 kPSAliasSuiteVersion,    
                                 &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.

#define kPSAliasSuiteVersion2 2

#define kPSAliasSuiteVersion kPSAliasSuiteVersion2

Typedef Documentation

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

NOTE that on the Mac, this suite should be considered deprecated as of Photoshop 17.0.

Please use bookmarks instead. See GetBookmark and PutBookmark function documentation in the ActionDescriptor and ActionList suites. Makes a new Mac OS alias from a C String.

Deprecated:: Please use NSURL functions to create bookmarks instead

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.

Deprecated:: Please use NSURL functions to create bookmarks instead

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.

Deprecated:: Please use NSURL functions to create bookmarks instead

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.

typedef SPAPI SPErr(* NewAliasFromCloudPathProc)(const char *cloudPath, AliasHandle *alias)

Makes a new alias from a cloud document path.

Parameters:

cloudPath	The C string with UTF8 encoding containing the cloud path from which to make an alias.
alias	[OUT] The alias, returned.

Returns:: Non-zero error if failure.

typedef SPAPI SPErr(* IsCloudFileProc)(AliasHandle alias, SPBoolean *isCloud)

Used to query whether or not an alias is representing a cloud file.

If it is, then it is valid to call CloudReferenceFromAlias or CloudPathFromAlias to get the cloud asset information.

Parameters:

alias	The alias to query. This may not be null.
isCloud	[OUT] True if the alias is representing a cloud file.

typedef SPAPI SPErr(* CloudReferenceFromAliasProc)(AliasHandle alias, ASZString *reference)

Used to get the cloud asset reference for an alias that is related to a cloud file.

This is the complete asset reference. This method should only be called if IsCloudFile returns true.

Parameters:

alias	The alias to query. This may not be null.
reference	[OUT] The asset reference for the cloud asset, Callers should treat this value as an opaque structure and callers should not try to create or alter such references using string operations.

typedef SPAPI SPErr(* CloudPathFromAliasProc)(AliasHandle alias, ASZString *reference)

Used to get the cloud asset reference path for an alias that is related to a cloud file.

This is the short asset reference. This method should only be called if IsCloudFile returns true.

Parameters:

alias	The alias to query. This may not be null
reference	[OUT] The asset reference for the cloud asset, Callers should treat this value as an opaque structure and callers should not try to create or alter such references using string operations.

typedef SPAPI SPErr(* NewAliasFromCloudReferenceProc)(const char *reference, AliasHandle *alias)

Used to create an alias from a cloud asset reference.

Parameters:

reference	The (cloud) asset reference for the cloud file. This value is typically obtained from a previous call to CloudReferenceFromAlias
alias	[OUT] The alias, returned.

typedef SPAPI SPErr(* UnicodePathToAliasProc)(const uint16 *unicodePath, AliasHandle *alias)

Used to create an alias from a unicode path.

Parameters:

unicodePath	The unicode path to the file. Use this routine for creating the alias from a previous CloudPathFromAlias call.
alias	[OUT] The alias, returned.

typedef SPAPI SPErr(* AliasToUnicodePathProc)(const AliasHandle alias, uint16 *unicodePath, uint32 length)

Used to create a unicode path from an alias.

Parameters:

alias	The alias to query. This may not be null.
unicodePath	[OUT] The unicode path, returned.
length	The maximum number of UTF16 characters to copy into unicodePath.

typedef PSAliasSuite2 PSAliasSuite

Getting Started

SDK API Reference

SDK API Features

Other Documentation

Data Structures

Defines

Typedefs

Detailed Description

Define Documentation

Typedef Documentation