CHLUtils Class Reference

#include <CHLUtils.h>

Static Public Member Functions
static ErrorCode	GetApplicationFolder (PMString &appFolder)
static ICoreFilename *	QueryCoreFilename (const PMString &fullPath)
static void	RemoveLastElement (PMString &fromthis)
static IPMStream *	CreateFileStreamRead (const PMString &fullPath)
static ErrorCode	FileExistsForRead (const PMString &fullPath)

Detailed Description

Utility helper class used in this plug-in.

Member Function Documentation

IPMStream * CHLUtils::CreateFileStreamRead ( const PMString &  fullPath )

static

Creates a file stream fo reading, using the given path.

Parameters

fullPath

IN Full path to file to open for reading.

Returns

IPMStream of the opened file. Nil if failure.

ErrorCode CHLUtils::FileExistsForRead ( const PMString &  fullPath )

static

Tests if the file exists and can be read.

Parameters

fullPath

IN Full path to file to open for reading.

Returns

kSuccess if file exists, kFailure otherwise.

ErrorCode CHLUtils::GetApplicationFolder ( PMString &  appFolder )

static

Gets the application folder. From this folder, you can get the "Plug-Ins" folder.

NOTE: For the Macintosh platform, this returns the InDesign installation folder path, not the path inside the package folder where the actual InDesign application binary resides.

Parameters

appFolder

OUT The complete path to the application folder.

Returns

kSuccess if success, kFailure otherwise.

static ICoreFilename* CHLUtils::QueryCoreFilename ( const PMString &  fullPath )

static

Queries the ICoreFileName. Unimplemented.

void CHLUtils::RemoveLastElement ( PMString &  fromthis )

static

Removes the last element from the path. We search for the last delimeter and knock off the stuff that comes after. We lose this data so beware!

Parameters

fromthis

IN/OUT Path from which you want to remove last element.