Classes | Namespaces | Macros | Typedefs | Enumerations | Functions
c4d_file.h File Reference

Classes

class  MemoryFileStruct
 
class  Filename
 
class  BaseFile
 
class  AESFile
 
class  LocalFileTime
 
class  BrowseFiles
 
class  BrowseVolumes
 
class  HyperFile
 

Namespaces

 maxon
 

Macros

#define GE_FILETIME_CREATED
 
#define GE_FILETIME_MODIFIED
 
#define GE_FILETIME_ACCESS
 
#define BROWSEFILES_CALCSIZE
 
#define BROWSEFILES_SUPPRESSCACHING
 
#define BROWSEVOLUMES_VOLUME_NOT_AVAILABLE
 
#define GE_FKILL_DIRECTORY
 
#define GE_FKILL_RECURSIVE
 
#define GE_FKILL_FORCE
 
#define GE_FCOPY_OVERWRITE
 
#define GE_FCOPY_DONTCOPYREADONLY
 
#define GE_FILE_ATTRIBUTE_READONLY
 
#define GE_FILE_ATTRIBUTE_HIDDEN
 
#define GE_FILE_ATTRIBUTE_LOCKED
 
#define GE_FILE_ATTRIBUTE_OWNER_R
 
#define GE_FILE_ATTRIBUTE_OWNER_W
 
#define GE_FILE_ATTRIBUTE_OWNER_X
 
#define GE_FILE_ATTRIBUTE_GROUP_R
 
#define GE_FILE_ATTRIBUTE_GROUP_W
 
#define GE_FILE_ATTRIBUTE_GROUP_X
 
#define GE_FILE_ATTRIBUTE_PUBLIC_R
 
#define GE_FILE_ATTRIBUTE_PUBLIC_W
 
#define GE_FILE_ATTRIBUTE_PUBLIC_X
 
#define GE_FILE_ATTRIBUTS_UNIX_MASK
 
#define C4D_PATH_PREFS
 
#define C4D_PATH_RESOURCE
 
#define C4D_PATH_LIBRARY
 
#define C4D_PATH_LIBRARY_USER
 
#define C4D_PATH_ONLINE_HELP
 
#define C4D_PATH_DESKTOP
 
#define C4D_PATH_HOME
 
#define C4D_PATH_STARTUPWRITE
 
#define C4D_PATH_MYDOCUMENTS
 
#define C4D_PATH_APPLICATION
 

Typedefs

typedef Filename RelativeFilename
 

Enumerations

enum class  MAXONCONVERTMODE {
  NONE ,
  READ ,
  WRITE
}
 

Functions

FILEERROR ReadHyperFile (BaseDocument *doc, GeListNode *node, const Filename &filename, Int32 ident, maxon::String *warning_string)
 
FILEERROR WriteHyperFile (BaseDocument *doc, GeListNode *node, const Filename &filename, Int32 ident)
 
Bool GeFExist (const Filename &name, Bool isdir=false)
 
Bool GeSearchFile (const Filename &directory, const Filename &name, Filename *found)
 
Bool GeFKill (const Filename &name, Int32 flags=0)
 
Bool GeFCopyFile (const Filename &source, const Filename &dest, Int32 flags)
 
Bool GeFRename (const Filename &source, const Filename &dest)
 
Bool GeFMove (const Filename &source, const Filename &dest)
 
Bool GeFCreateDir (const Filename &name)
 
Bool GeFCreateDirRec (const Filename &name)
 
Bool GeFGetDiskFreeSpace (const Filename &vol, UInt64 &freecaller, UInt64 &total, UInt64 &freespace)
 
UInt32 GeFGetAttributes (const Filename &name)
 
Bool GeFSetAttributes (const Filename &name, UInt32 flags, UInt32 mask=(UInt32) - 1)
 
Bool GeExecuteFile (const Filename &path)
 
Bool GeExecuteProgram (const Filename &program, const Filename &file)
 
const Filename GeGetStartupPath (void)
 
const Filename GeGetStartupApplication (void)
 
const Filename GeGetStartupWritePath (void)
 
const Filename GeGetPluginPath (void)
 
Filename GeGetPluginResourcePath ()
 
const Filename GeGetC4DPath (Int32 whichpath)
 
Bool GeGetFileTime (const Filename &name, Int32 mode, LocalFileTime *out)
 
Bool GeSetFileTime (const Filename &name, Int32 mode, const LocalFileTime *in)
 
void GeGetCurrentTime (LocalFileTime *out)
 
String DateToString (const LocalFileTime &t, Bool date_only)
 
Bool ShowInFinder (const Filename &fn, Bool open)
 
Bool RequestFileFromServer (const Filename &fn, Filename &res)
 
maxon::String ToString (const Filename &val, const maxon::FormatStatement *formatStatement, maxon::Bool checkDatatype=false)
 
maxon::Url MaxonConvert (const Filename &fn, MAXONCONVERTMODE convertMode)
 
Filename MaxonConvert (const maxon::Url &fn)
 

Typedef Documentation

◆ RelativeFilename

typedef Filename RelativeFilename

Filename path is relative.

Enumeration Type Documentation

◆ MAXONCONVERTMODE

enum MAXONCONVERTMODE
strong
Enumerator
NONE 

No check if file exists under case-sensitive drives.

READ 

Check for file read operation.

WRITE 

Check for file write operation.

Function Documentation

◆ GeGetCurrentTime()

void GeGetCurrentTime ( LocalFileTime *  out)

Gets the current time.

Parameters
[out]outFilled with the current time. The caller owns the pointed file time.

◆ DateToString()

String DateToString ( const LocalFileTime &  t,
Bool  date_only 
)

Converts the value of a LocalFileTime into a string.

Note
The format of the returned string depends on the current OS date and time settings.
Parameters
[in]tThe file time to convert.
[in]date_onlyIf true only the date part will be converted.
Returns
A String representing the LocalFileTime value.

◆ ShowInFinder()

Bool ShowInFinder ( const Filename &  fn,
Bool  open 
)

Shows the file/path in the Finder (Mac) or Explorer (Windows).

Parameters
[in]fnThe file/path to show.
[in]openIf true the file will be opened by the assigned application.
Returns
true if the path/file exists, otherwise false.

◆ RequestFileFromServer()

Bool RequestFileFromServer ( const Filename &  fn,
Filename &  res 
)

Private.

◆ ToString()

maxon::String ToString ( const Filename &  val,
const maxon::FormatStatement *  formatStatement,
maxon::Bool  checkDatatype = false 
)

◆ MaxonConvert() [1/2]

maxon::Url MaxonConvert ( const Filename &  fn,
MAXONCONVERTMODE  convertMode 
)

◆ MaxonConvert() [2/2]

Filename MaxonConvert ( const maxon::Url &  fn)