AIFoldersSuite Struct Reference
[API Suite List]

This suite provides functions to get the locations of the standard folders used by Illustrator. More...

#include <AIFolders.h>

Public Attributes
AIAPI AIErr(*	FindFolder )(AIFolderType type, AIBoolean createFolder, ai::FilePath &folder)
	Gets a path for an Illustrator folder.
AIAPI AIErr(*	GetFolderName )(AIFolderType type, ai::UnicodeString &name)
	Retrieves the file-system name of an Illustrator folder.
AIAPI AIErr(*	GetFileName )(AIFileType type, ai::FilePath &file)
	Creates a file path object for a temporary file.

Detailed Description

This suite provides functions to get the locations of the standard folders used by Illustrator.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIFoldersSuite and kAIFoldersVersion.

The following shows the layout of these folders and the corresponding identifiers.

Local Hierarchy

Adobe Illustrator x		<- kAIRootFolderType
	Adobe Illustrator x:	<- kAIPackageFolderType
  	  Contents:		<- kAIContentsFolderType
  	    Windows/MacOSClassic: <- kAIApplicationFolderType
  	      +Executable
  	      +Shared libraries
  	    Help:		<- kAIHelpFolderType
  	      +HTML Help Files
  	      images:		<- kAIHelpImagesFolderType
  	        +Help graphics
  	  Helpers:		<- kAIHelpersFolderType
  	    Preview In:		<- kAIPreviewInFolderType
  	  Required:		<- kAIRequiredFolderType
  	    +Required plug-ins
  	    Fonts:		<- kAIRequiredFontsFolderType
  	      +Required fonts
  	    Startup Profiles <- kAIRequiredStartupProfilesFolderType
		  +Startup files

  	Legal:		<- kAILegalFolderType
  	  +EULA

  	Plug-ins:	<- kAIPluginsFolderType (user can not change as of AI13)
			(kAIStartupFileFolderType, kAIRidersFileFolderType both point here)
  	  Extensions:
  	  Illustrator Filters:
  	  Illustrator Formats:	<- kAIIllustratorFormatsFolderType
  	  Photoshop Effects:
  	  Photoshop Filters:
  	  Photoshop Formats:
  	  Text Filters:
  	  Tools:	<- kAIToolsFolderType
  	  Tsume:	<- kAITsumeFolderType

  	Presets:	<- kAIPresetsFolderType
		(Note: The presets folder and subfolders are in the application directory and may not be writable.
		 To write settings files, use one of the kAIUserSupport folders or the kAIUserWritable folders.)
  	  Actions:	<- kAIPresetActionsFolderType
  	  Brushes:	<- kAIPresetBrushesFolderType
  	  Keyboard Shortcuts: <- kAIPresetKeyboardShortcutsFolderType
  	  Save for Web Settings: <- kAISettingsFolderType
  	    Color Tables: <- kAIColorTableSettingsFolderType
  	      +Color tables
  	    Optimize:	<- kAIOptimizeSettingsFolderType
  	      +Optimize settings
	    Output Settings:
	      +Output settings <- kAIOutputSettingsFolderType
  	  Scripts:	<- kAIPresetScriptsFolderType
  	  Styles:	<- kAIPresetStylesFolderType
  	  Swatches:	<- kAIPresetSwatchesFolderType + kAIPresetSwatchExchangeFolderType
  	    Color Systems: <- kAIPresetColorSystemsFolderType
		Color Books:	<- kAIPresetColorBooksFolderType
		  Legacy:	<- kAIPresetLegacyColorBooksFolderType
	    Gradients:	<- kAIPresetGradientsFolderType
  	    Patterns:	<- kAIPresetPatternsFolderType
  	  Symbols:	<- kAIPresetSymbolsFolderType
  	  Templates:	<- kAIPresetTemplatesFolderType
  	    Blank Documents: <- kAIPresetBlankDocumentsFolderType
	  Flash Panels: <- kAIPresetFlashPanelsFolderType
  	    Welcome Screen: <- kAIPresetWelcomeScreenFolderType
	  Workspaces:	<- kAIPresetWorkspacesFolderType
	  Tools:	<- kAIPresetToolsFolderType

  	Fonts:		<- kAIFontsFolderType
  	  CMaps:	<- kAIFontsCMapsFolderType

  	Sample Files:	<- kAISampleFilesFolderType
  	  Graph Designs: <- kAISampleGraphDesignsFolderType
  	  Sample Art:	<- kAISampleArtFolderType
  	    SVG:	<- kAISampleSVGFolderType
  	    Data-Driven Graphics: <- kAIDataDrivenGraphicsFolderType

  	StartupScripts:	<- kAIStartupScriptsFolderType

  	Utilities:	<- kAIUtilitiesFolderType

System Hierarchies

The following describes the parts of the Illustrator directory hierarchy that are located under system folders. The platform-specific directory names are shown following.

  	[PrimaryScratch]	<- kAIPrimaryScratchFolderType + primary scratch file location
  	[SecondaryScratch]	<- kAISecondaryScratchFolderType + secondary scratch file location
  	[AIPreferences]		<- kAIPreferencesFolderType + preferences file location + plug-in cache file location
  	[UserSupport]		<- kAIUserSupportFolderType
  		Adobe Illustrator X	<- kAIUserSupportAIFolderType
			Startup Templates: <- kAIUserWritableStartupFileFolderType
  			Plug-ins	<- kAIUserSupportAIPluginsFolderType + plug-ins available to current user
			Composite Fonts <- kAIFontsCFFolderType
			 Temp	<- kAIFontsCFTempFolderType
		    Brushes <- kAIUserWritablePresetBrushesFolderType
			Graphic Styles <- kAIUserWritablePresetStylesFolderType
			Swatches <- kAIUserWritablePresetSwatchesFolderType + kAIUserWritablePresetSwatchExchangeFolderType
			Symbols <- kAIUserWritablePresetSymbolsFolderType
			Save for Web Settings <- kAIUserWritablePresetSettingsFolderType
				Color Tables	<- kAIUserWritablePresetColorTableSettingsFolderType
				Optimize		<- kAIUserWritablePresetOptimizeSettingsFolderType
				Output Settings	<- kAIUserWritablePresetOutputSettingsFolderType
  		Fonts	<- kAIUserSupportCommonFontsFolderType
  	[ApplicationSupportCommon]	<- kAIApplicationSupportCommonFolderType
  		Color	<- kAIApplicationSupportCommonColorFolderType
  			Profiles	<- kAIApplicationSupportCommonColorProfilesFolderType
  			Settings	<- kAIApplicationSupportCommonColorSettingsFolderType
  		typeSpt	<- kAIApplicationSupportCommonTypeSupportFolderType
  			Kinsoku Sets	<- kAIApplicationSupportCommonKinsokuSetFolderType
  			Mojikume Sets	<- kAIApplicationSupportCommonMojikumeSetFolderType
  		Fonts	<- kAIApplicationSupportCommonFontsFolderType
  			Reqrd	<- kAIApplicationSupportCommonFontsReqrdFolderType
  				Base	<- kAIApplicationSupportCommonFontsReqrdBaseFolderType
  				cmaps	<- kAIApplicationSupportCommonFontsReqrdCMapsFolderType
  		PDFL	<- kAIApplicationSupportCommonPDFLFolderType
  			PDFL5.0	<- kAIApplicationSupportCommonPDFL5FolderType
  				cmaps	<- kAIApplicationSupportCommonPDFL5CMapsFolderType
  				fonts	<- kAIApplicationSupportCommonPDFL5FontsFolderType
  		Printspt	<- kAIApplicationSupportCommonPrintSupportFolderType
  		Workflow	<- kAIApplicationSupportCommonWorkflowFolderType
  		Linguistics	<- kAIApplicationSupportCommonLinguisticsFolderType
  			Providers	<- kAIApplicationSupportCommonLinguisticsProvidersFolderType
  				Proximity	<- kAIDictionariesFolderType, kAIHyphenationDictFolderType,kAISpellingDictFolderType (all point at same folder)
  	[MyDocuments]	<- kAIMyDocumentsFolderType + default documents file location
  	[PPDs]	<- kAIPrinterDescriptionsFolderType + PPD location
  	[Logs]	<- kAILogsFolderType
  	[AdditionalPlugins]	<- kAIAdditionalAIPluginsFolderType + additional plug-ins location (new in AI13, user can change in Preferences)

Platform-specific Directories

Windows 2000

  PrimaryScratch = System definition of temporary but can be changed by user
  SecondaryScratch = System definition of temporary but can be changed by user
  AIPreferences = Documents and Settings\username\Application Data\Adobe\Adobe Illustrator X
  UserSupport = Documents and Settings\username\Application Data\Adobe
  ApplicationSupportCommon = Program Files\Common Files\Adobe
  MyDocuments = Documents and Settings\username\My Documents
  PPDs = unknown
  Logs = Documents and Settings\username\Application Data\Adobe\Logs
  kAIResourcesFolderType = kAIApplicationFolderType
  kAIDesktopFolderType = CSIDL_DESKTOPDIRECTORY: The file system directory used
						   to physically store file objects on the desktop (not to 
						   be confused with the desktop folder itself). A typical 
						   path is C:\Documents and Settings\username\Desktop.
  AdditionalPlugins = Arbitrary location can be specified by user in Preferences

Mac OS X

  PrimaryScratch = System definition of temporary but can be changed by user
  SecondaryScratch = System definition of temporary but can be changed by user
  AIPreferences = ~/Library/Preferences/Adobe Illustrator X
  UserSupport = ~/Library/Application Support/Adobe
  ApplicationSupportCommon = /Library/Application Support/Adobe
  MyDocuments = ~/Documents
  PPDs = Libraries/Printers/PPDs
  Logs = ~/Library/Logs/Adobe Illustrator CS
  kAIResourcesFolderType = kAIApplicationFolderType/Resources
  kAIDesktopFolderType = ~/Desktop
  AdditionalPlugins = Arbitrary location can be specified by user in Preferences

Member Data Documentation

AIAPI AIErr(* AIFoldersSuite::FindFolder)(AIFolderType type, AIBoolean createFolder, ai::FilePath &folder)

Gets a path for an Illustrator folder.

Parameters:

	type	The Illustrator folder to find.
	createFolder	When true, creates a folder of the given type if it does not already exist.
	folder	[out] A buffer in which to return the folder path.

AIAPI AIErr(* AIFoldersSuite::GetFileName)(AIFileType type, ai::FilePath &file)

Creates a file path object for a temporary file.

Generates a unique, temporary file name. Does not check whether the file exists.

Parameters:

	type	The file type, must be `kAITemporaryFileType`.
	file	[out] A buffer in which to return the file path.

AIAPI AIErr(* AIFoldersSuite::GetFolderName)(AIFolderType type, ai::UnicodeString &name)

Retrieves the file-system name of an Illustrator folder.

Parameters:

	type	The Illustrator folder.
	name	[out] A buffer in which to return the name of the folder (not the full path). Must be of size `kMaxPathLength`.

The documentation for this struct was generated from the following file:

AIFolders.h

AIFoldersSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIFoldersSuite Struct Reference
[API Suite List]