SPFiles.h File Reference

#include "SPTypes.h"
#include "SPProps.h"
#include "SPHeaderBegin.h"
#include <cstring>
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPPlatformFileSpecification
	A file specification In Mac OS.It is the same as FSSpec. More...
struct	SPPlatformFileReference
	A file reference in terms of a string. More...
struct	SPPlatformFileInfo
	Platform-specific file metadata. More...
struct	SPPlatformFileSpecification
	A file specification In Mac OS.It is the same as FSSpec. More...
struct	SPPlatformFileSpecificationW
struct	SPPlatformFileInfo
	Platform-specific file metadata. More...
struct	SPFilesSuite
	This suite allows you to access the PICA files list. More...
Defines
#define	kSPFilesSuite   "SP Files Suite"
	Files suite name.
#define	kSPFilesSuiteVersion3   3
#define	kSPFilesSuiteVersion   4
#define	kSPRuntimeFileList   ((SPFileListRef)NULL)
	PICA global list of potential plug-in files.
#define	kFileDoesNotHavePiPL   (SPPropertyListRef)(~((size_t)NULL))
	Return value for SPFilesSuite::GetFilePropertyList(), indicating that the file has no property list.
#define	kFileHasMulitplePiPLs   NULL
	Return value for SPFilesSuite::GetFilePropertyList(), indicating that the file has multiple property lists.
#define	kMaxPathLength   1024
#define	kMaxPathLength   300
Typedefs
typedef struct SPFile *	SPFileRef
	The maximum number of characters allowed in a file path specification.
typedef struct SPFileList *	SPFileListRef
	Opaque reference to a file list.
typedef struct SPFileListIterator *	SPFileListIteratorRef
	Opaque reference to a file-list iterator.
typedef struct OpaqueSPPlatformFileRef	SPPlatformFileRef
	Opaque reference to a platform-specific file specification.
typedef SPPlatformFileSpecificationW	SPPlatformFileReference
	Same as SPPlatformFileSpecification on Windows.
typedef SPBoolean(*	SPAddPiPLFilterProc )(SPPlatformFileInfo *info)
	Internal.
Functions
SPErr	FileSpectoFileRef (const SPPlatformFileSpecification *fileSpec, const SPPlatformFileReference *fileRef)
SPErr	FileReftoFileSpec (const SPPlatformFileReference *fileRef, const SPPlatformFileSpecification *fileSpec)
SPAPI SPErr	SPAllocateFileList (SPFileListRef *fileList)
	Internal.
SPAPI SPErr	SPFreeFileList (SPFileListRef fileList)
	Internal.
SPAPI SPErr	SPAddFiles (SPFileListRef fileList, const SPPlatformFileReference *file)
SPAPI SPErr	SPNewFileListIterator (SPFileListRef fileList, SPFileListIteratorRef *iter)
	Internal.
SPAPI SPErr	SPNextFile (SPFileListIteratorRef iter, SPFileRef *file)
	Internal.
SPAPI SPErr	SPDeleteFileListIterator (SPFileListIteratorRef iter)
	Internal.
SPAPI SPErr	SPGetFileSpecification (SPFileRef file, SPPlatformFileSpecification *fileSpec)
	Internal.
SPAPI SPErr	SPGetFileReference (SPFileRef file, SPPlatformFileReference *fileSpec)
SPAPI SPErr	SPGetFileInfo (SPFileRef file, SPPlatformFileInfo *info)
	Internal.
SPAPI SPErr	SPGetIsAPlugin (SPFileRef file, SPBoolean *isAPlugin)
	Internal.
SPAPI SPErr	SPSetIsAPlugin (SPFileRef file, SPBoolean isAPlugin)
	Internal.
SPAPI SPErr	SPGetFilePropertyList (SPFileRef file, SPPropertyListRef *propertList)
	Internal.
SPAPI SPErr	SPSetFilePropertyList (SPFileRef file, SPPropertyListRef propertList)
	Internal.
SPAPI SPErr	SPAddFilePiPLs (SPFileListRef fileList, SPAddPiPLFilterProc filter)
	Internal.

---

Define Documentation

#define kFileDoesNotHavePiPL   (SPPropertyListRef)(~((size_t)NULL))

Return value for SPFilesSuite::GetFilePropertyList(), indicating that the file has no property list.

#define kFileHasMulitplePiPLs   NULL

Return value for SPFilesSuite::GetFilePropertyList(), indicating that the file has multiple property lists.

Use SPPluginsSuite::GetPluginPropertyList() to access the PiPL for each SPPluginRef exported by the file.

#define kMaxPathLength   300

#define kMaxPathLength   1024

#define kSPFilesSuite   "SP Files Suite"

Files suite name.

#define kSPFilesSuiteVersion   4

#define kSPFilesSuiteVersion3   3

#define kSPRuntimeFileList   ((SPFileListRef)NULL)

PICA global list of potential plug-in files.

See also:

SPRuntimeSuite::GetRuntimeFileList()

---

Typedef Documentation

typedef SPBoolean(* SPAddPiPLFilterProc)(SPPlatformFileInfo *info)

Internal.

typedef struct SPFileListIterator* SPFileListIteratorRef

Opaque reference to a file-list iterator.

Access with the SPFilesSuite.

typedef struct SPFileList* SPFileListRef

Opaque reference to a file list.

Access with the SPFilesSuite.

typedef struct SPFile* SPFileRef

The maximum number of characters allowed in a file path specification.

Opaque reference to a file. Access with the SPFilesSuite.

typedef struct OpaqueSPPlatformFileRef SPPlatformFileRef

Opaque reference to a platform-specific file specification.

Access with the SPFilesSuite.

typedef SPPlatformFileSpecificationW SPPlatformFileReference

Same as SPPlatformFileSpecification on Windows.

VS_TODO: This is just the initial definition in order to reduce the impact. We need to get rid of SPPlatformFileSpecification one day. Also, SPPlatformFileRef is already defined above and it does not seem to be used anywhere. I think we should remove it.

---

Function Documentation

SPErr FileReftoFileSpec	(	const SPPlatformFileReference *	fileRef,
		const SPPlatformFileSpecification *	fileSpec
	)

SPErr FileSpectoFileRef	(	const SPPlatformFileSpecification *	fileSpec,
		const SPPlatformFileReference *	fileRef
	)

SPAPI SPErr SPAddFilePiPLs	(	SPFileListRef	fileList,
		SPAddPiPLFilterProc	filter
	)

Internal.

SPAPI SPErr SPAddFiles	(	SPFileListRef	fileList,
		const SPPlatformFileReference *	file
	)

SPAPI SPErr SPAllocateFileList

(

SPFileListRef *

fileList

)

Internal.

SPAPI SPErr SPDeleteFileListIterator

(

SPFileListIteratorRef

iter

)

Internal.

SPAPI SPErr SPFreeFileList

(

SPFileListRef

fileList

)

Internal.

SPAPI SPErr SPGetFileInfo	(	SPFileRef	file,
		SPPlatformFileInfo *	info
	)

Internal.

SPAPI SPErr SPGetFilePropertyList	(	SPFileRef	file,
		SPPropertyListRef *	propertList
	)

Internal.

SPAPI SPErr SPGetFileReference	(	SPFileRef	file,
		SPPlatformFileReference *	fileSpec
	)

SPAPI SPErr SPGetFileSpecification	(	SPFileRef	file,
		SPPlatformFileSpecification *	fileSpec
	)

Internal.

SPAPI SPErr SPGetIsAPlugin	(	SPFileRef	file,
		SPBoolean *	isAPlugin
	)

Internal.

SPAPI SPErr SPNewFileListIterator	(	SPFileListRef	fileList,
		SPFileListIteratorRef *	iter
	)

Internal.

SPAPI SPErr SPNextFile	(	SPFileListIteratorRef	iter,
		SPFileRef *	file
	)

Internal.

SPAPI SPErr SPSetFilePropertyList	(	SPFileRef	file,
		SPPropertyListRef	propertList
	)

Internal.

SPAPI SPErr SPSetIsAPlugin	(	SPFileRef	file,
		SPBoolean	isAPlugin
	)

Internal.