PIAliasSuite.h

Go to the documentation of this file.

// ADOBE SYSTEMS INCORPORATED
// Copyright  2003 - 2005 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE:  Adobe permits you to use, modify, and distribute this 
// file in accordance with the terms of the Adobe license agreement
// accompanying it.  If you have received this file from a source
// other than Adobe, then your use, modification, or distribution
// of it requires the prior written permission of Adobe.
//-------------------------------------------------------------------
#pragma once

#ifndef __PIAliasSuite__
#define __PIAliasSuite__

//-------------------------------------------------------------------------------
//  Includes.
//-------------------------------------------------------------------------------
#include "PIGeneral.h"

//-------------------------------------------------------------------------------
//  C++ wrapper.
//-------------------------------------------------------------------------------
#ifdef __cplusplus
extern "C" {
#endif

//-------------------------------------------------------------------------------
//  UI Alias suite.
//-------------------------------------------------------------------------------
#define kPSAliasSuite               "Photoshop Alias Utility Suite"


//-------------------------------------------------------------------------------
//  
//-------------------------------------------------------------------------------

#if MSWindows
typedef struct AliasRecord* AliasPtr;
typedef AliasPtr* AliasHandle;
#endif

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

typedef SPAPI SPErr         (*MacNewAliasFromFSRefProc)( const void *fsRefToFile, AliasHandle *alias  );
    
typedef SPAPI SPErr         (*MacNewAliasFromNameAndFSRefProc)( const void *cfStringFilename, const void *fsRefToParentDir, AliasHandle *alias );
    
typedef SPAPI SPErr         (*WinNewAliasFromWidePathProc)( const uint16 *filePathAsUTF16, AliasHandle *alias );

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

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

typedef  SPAPI SPErr        (*IsCloudFileProc) ( AliasHandle alias, SPBoolean* isCloud );
 
typedef  SPAPI SPErr        (*CloudReferenceFromAliasProc) ( AliasHandle alias, ASZString* reference );
 
typedef  SPAPI SPErr        (*CloudPathFromAliasProc) ( AliasHandle alias, ASZString* reference );
 
typedef  SPAPI SPErr        (*NewAliasFromCloudReferenceProc) ( const char *reference, AliasHandle *alias );

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

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




//-------------------------------------------------------------------------------
//   Alias suite versions 1 & 2.
//-------------------------------------------------------------------------------

#define kPSAliasSuiteVersion1       1
#define kPSAliasSuiteVersion2       2
#define kPSAliasSuiteVersion        kPSAliasSuiteVersion2   // Current version.

typedef struct 
    {
        // kPSAliasSuiteVersion1
        MacNewAliasFromCStringProc MacNewAliasFromCString;              
        MacNewAliasFromFSRefProc MacNewAliasFromFSRef;                  
        MacNewAliasFromNameAndFSRefProc MacNewAliasFromNameAndFSRef;    
        WinNewAliasFromWidePathProc WinNewAliasFromWidePath;            
        WinNewAliasFromPIDLProc WinNewAliasFromPIDL;                    
    } PSAliasSuite1;

typedef struct 
    {
        // kPSAliasSuiteVersion1
        MacNewAliasFromCStringProc MacNewAliasFromCString;              
        MacNewAliasFromFSRefProc MacNewAliasFromFSRef;                  
        MacNewAliasFromNameAndFSRefProc MacNewAliasFromNameAndFSRef;    
        WinNewAliasFromWidePathProc WinNewAliasFromWidePath;            
        WinNewAliasFromPIDLProc WinNewAliasFromPIDL;                    
        // kPSAliasSuiteVersion2
        NewAliasFromCloudPathProc NewAliasFromCloudPath;                
        IsCloudFileProc IsCloudFile;                                    
        CloudReferenceFromAliasProc CloudReferenceFromAlias;            
        CloudPathFromAliasProc CloudPathFromAlias;                      
        NewAliasFromCloudReferenceProc NewAliasFromCloudReference;      
        UnicodePathToAliasProc UnicodePathToAlias;                      
        AliasToUnicodePathProc AliasToUnicodePath;                      
    } PSAliasSuite2;

typedef PSAliasSuite2 PSAliasSuite;

//-------------------------------------------------------------------------------
//  C++ wrapper.
//-------------------------------------------------------------------------------
#ifdef __cplusplus
}
#endif

#endif // __PIAliasSuite__