IShFileUtilities Struct Reference
[Shell Utilities]

File utilities provided by the shell for IMCFile handling. More...

Inheritance diagram for IShFileUtilities:

IMCUnknown List of all members.

Public Member Functions

virtual MCCOMErr MCCOMAPI GetSeparator (TMCString &sepString)=0
virtual MCCOMErr MCCOMAPI GetBaseNameMaxLength (int32 &maxLength)=0
virtual MCCOMErr MCCOMAPI CleanPathName (TMCString &thePathName)=0
virtual MCCOMErr MCCOMAPI GetAppDirectory (TMCString &outString)=0
virtual void MCCOMAPI GetExtensionsFolder (IMCFile **outFolder)=0
virtual MCCOMErr MCCOMAPI CreateIMCFile (IMCFile **pFile)=0
virtual MCCOMErr MCCOMAPI CreateIMCFileIterator (IMCFileIterator **fileIterator, const TMCString &dir, const TMCFileType *fileTypeRec, boolean resolveAliases=true)=0

Detailed Description

File utilities provided by the shell for IMCFile handling.

Member Function Documentation

virtual MCCOMErr MCCOMAPI IShFileUtilities::CleanPathName (  TMCString &  thePathName  )  [pure virtual]
 

Modifies a path name string (generally, one read from a file) to use the correct separators for this platform.

Parameters:
thePathName Returns the modified path string

virtual MCCOMErr MCCOMAPI IShFileUtilities::CreateIMCFile (  IMCFile **  pFile  )  [pure virtual]
 

Creates a new file record.

Parameters:
pFile 

virtual MCCOMErr MCCOMAPI IShFileUtilities::CreateIMCFileIterator (  IMCFileIterator **  fileIterator,
const TMCString &  dir,
const TMCFileType *  fileTypeRec,
boolean  resolveAliases = true
)  [pure virtual]
 

Creates a file iterator.

See also:
IMCFileIterator

TMCFileType

Parameters:
fileIterator Returns a pointer to the file iterator
dir Path
fileTypeRec Pointer to a TMCFileType file type specifier to restrict the set of files over which the iterator iterates.
resolveAliases If true, the file iterator will resolve aliases/shortcuts, pointing at their destination.

virtual MCCOMErr MCCOMAPI IShFileUtilities::GetAppDirectory (  TMCString &  outString  )  [pure virtual]
 

Returns the path to the application.

Parameters:
outString Returns the path

virtual MCCOMErr MCCOMAPI IShFileUtilities::GetBaseNameMaxLength (  int32 &  maxLength  )  [pure virtual]
 

Returns the maximum length of a file path

Parameters:
maxLength Returns the max length

virtual void MCCOMAPI IShFileUtilities::GetExtensionsFolder (  IMCFile **  outFolder  )  [pure virtual]
 

Returns the application's extensions folder.

Parameters:
outFolder Returns a pointer to an IMCFile with the path to the extensions folder.

virtual MCCOMErr MCCOMAPI IShFileUtilities::GetSeparator (  TMCString &  sepString  )  [pure virtual]
 

Returns the string used as a path element separator.

Parameters:
sepString Returns the path element separator string

The documentation for this struct was generated from the following file:
Generated on Mon Mar 14 12:29:05 2005 for Carrara SDK Doc by  doxygen 1.3.9.1