Get Path Suite

The Get Path suite gets the path from a file specification. More...

Data Structures
struct	PSGetPathSuite1
	The routines available in the Get Path Suite. More...
Defines
#define	kPSGetPathSuite   "Photoshop GetPath Suite for Plug-ins"
	Unique identifier for the Get Path Suite.
#define	kPSGetPathSuiteVersion1   1
	Current version for the Get Path Suite.
#define	kPSGetPathSuiteVersion2   2
Typedefs
typedef SPAPI void(*	GetPathNameProc )(SPPlatformFileSpecification *fileSpec, char *path, int16 maxLength)
	Gets the path name from the file specification.
typedef SPAPI void(*	GetXPlatPathNameProc )(XPlatFileSpec *fileSpec, char *path, int16 maxLength)

---

Detailed Description

The Get Path suite gets the path from a file specification.

The Get Path Suite is available in Adobe Photoshop 5.5 and later.

Accessing the Suite

The Get Path Suite suite is referred to as:

  #define kPSGetPathSuite           "Photoshop GetPath Suite for Plug-ins"

The current version of the Get Path suite:

  #define kPSGetPathSuiteVersion1       1

The suite is acquired as follows:

  PSGetPathSuite1 *sPSGetPath;
  error = sSPBasic->AcquireSuite(kPSGetPathSuite,
                                 kPSGetPathSuiteVersion1,     
                                 &sPSGetPath);
  if (error) goto . . . //handle error

For PICA errors, see SPErrorCodes.h.

---

Define Documentation

#define kPSGetPathSuite   "Photoshop GetPath Suite for Plug-ins"

Unique identifier for the Get Path Suite.

#define kPSGetPathSuiteVersion1   1

Current version for the Get Path Suite.

#define kPSGetPathSuiteVersion2   2

---

Typedef Documentation

typedef SPAPI void(* GetPathNameProc)(SPPlatformFileSpecification *fileSpec, char *path, int16 maxLength)

Gets the path name from the file specification.

Parameters:

fileSpec	File specification.
path	[OUT] Path name, returned.
maxLength	Maximum length of the path name.

typedef SPAPI void(* GetXPlatPathNameProc)(XPlatFileSpec *fileSpec, char *path, int16 maxLength)