Polygon Crucher SDK - Documentation
Documentation
Loading...
Searching...
No Matches
CFileInfo Class Reference

A convenient class to get some information giving a specific file name through a CFileNameSpec object. More...

Detailed Description

A convenient class to get some information giving a specific file name through a CFileNameSpec object.

#include <FileInfo.h>

Public Member Functions

void Init (const CFileNameSpec &filepec, FILENAME_TYPE type=FILENAME_UNKNOWN)
 Retrieve info about a file giving a CFileNameSpec. If known type can be provided to resolve some name ambiguities (if path is relative for example)
 
CXString GetCompleteName () const
 Return filename (path included)
 
CXString GetName () const
 Return filename (without path)
 
CXString GetPath () const
 Return path.
 
CXString GetRoot () const
 Return root.
 
CXString GetExtension () const
 Return extension.
 
CXString GetNameWithoutExt () const
 Return filename (without path and extension)
 
CXString GetPathWithoutRoot () const
 Return path without root.
 
CXString GetQuery (bool includeQuestionMark=true) const
 Return query if path is an url. includeQuestionMark keeps the ? unless no query is specified.
 
unsigned int GetParserNbr () const
 Return the parser number for the extension.
 
bool CanTryAnotherParser () const
 
void TryNextParser ()
 
unsigned int GetLoader () const
 Return loader of file.
 
unsigned int GetSaver () const
 Return saver of file.
 
unsigned int GetProperties () const
 Return type of file.
 
unsigned int GetKindOf () const
 Return kind of file.
 
unsigned int GetClass () const
 Return type file class.
 
InitIOPluginFunc GetInitIoCallback ()
 Return the parser initializer function if parser is added at runtime. It can be located in a plugin (moox extension that export or define as a callback.
 
bool IsFile () const
 Is the filename a file?
 
bool IsURL () const
 Is the filename an URL? Note: An URL can also be a directory or a file.
 
bool IsDirectory () const
 Is the filename a directory?
 
bool IsUNCPath ()
 Is the file on network?
 
CXString GetTopDirectory () const
 Return the directory name which contain the file.
 
CXString GetParentDirectory () const
 Return the parent directory path.
 
int GetDigitInfo (CXString &dstname, CXString &digitstring, bool addWildcard=false, bool endDigitOnly=false) const
 Return the digit value of the file, the name without digit, and the digit string. If several digit exists, first look at the end of the string, then the beginning. begaddWildcard = true, then * replace the digit. endDigitOnly, only care digit which are at the end of the string (not the beginning, if some exists)
 
bool IsSameFile (const CXString &filename) const
 
bool IsSameDir (const CXString &cmpfilename) const
 

Static Public Member Functions

static int GetDigit (const CXString &filename)
 Return the digit value of the file, the name without digit, and the digit string.
 

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