ioenums.h File Reference

Namespaces

  maxon
  maxon::URLFLAGS

Enumerations

enum   IOTIMEMODE {
   CREATED ,
   MODIFIED ,
   ACCESSED
}
enum   URLCOMPARE {
   DEFAULT ,
   NORMALIZE ,
   IONORMALIZE ,
   LEGACY
}
enum   IODETECT {
   ERRORSTATE ,
   NONEXISTENT ,
   UNKNOWN ,
   FILE ,
   LINK ,
   DIRECTORY
}
enum   OPENSTREAMFLAGS {
   NONE ,
   WRITE_DONT_TRUNCATE ,
   ALLOW_SHARED_READ_WRITE_ACCESS ,
   SEEK_TO_END ,
   FULL_DUPLEX ,
   ASK_FOR_REMOVE_WRITE_PROTECTION
}
enum   NORMALIZEFLAGS {
   NONE ,
   SCHEME_BASED ,
   CASE ,
   PATH_SEGMENT ,
   UNICODE_DECOMPOSITION ,
   UNDERLYING
}
enum   IOATTRIBUTES : UInt {
   NONE ,
   READONLY ,
   HIDDEN ,
   ARCHIVE ,
   LOCKED ,
   OWNER_R ,
   OWNER_W ,
   OWNER_X ,
   GROUP_R ,
   GROUP_W ,
   GROUP_X ,
   PUBLIC_R ,
   PUBLIC_W ,
   PUBLIC_X ,
   RW_MASK ,
   RWX_MASK ,
   MASK_ALL
}
enum   IOSHOWINOSFLAGS {
   NONE ,
   SHOW_IN_EXPLORER ,
   OPEN_IN_EXPLORER
}

函数

enum maxon::IOTIMEMODE   MAXON_ENUM_LIST (IOTIMEMODE, "net.maxon.datatype.enum.iotimemode")
enum maxon::URLCOMPARE   MAXON_ENUM_LIST (URLCOMPARE, "net.maxon.datatype.enum.urlcompare")
enum maxon::IODETECT   MAXON_ENUM_LIST (IODETECT, "net.maxon.datatype.enum.iodetect")
enum maxon::OPENSTREAMFLAGS   MAXON_ENUM_FLAGS (OPENSTREAMFLAGS, "net.maxon.datatype.enum.openstreamflags")
enum maxon::NORMALIZEFLAGS   MAXON_ENUM_FLAGS (NORMALIZEFLAGS, "net.maxon.datatype.enum.normalizeflags")
enum maxon::IOATTRIBUTES UInt   MAXON_ENUM_FLAGS (IOATTRIBUTES, "net.maxon.datatype.enum.ioattributes")
void  ConvertIoAttributes (IOATTRIBUTES &attributes)
enum maxon::IOSHOWINOSFLAGS   MAXON_ENUM_FLAGS (IOSHOWINOSFLAGS, "net.maxon.datatype.enum.ioshowinosflags")
  MAXON_ATTRIBUTE ( Bool , DUMMY, "net.maxon.dummy")

变量

  CREATED
  MODIFIED
  ACCESSED
  DEFAULT
  NORMALIZE
  IONORMALIZE
  LEGACY
  ERRORSTATE
  NONEXISTENT
  UNKNOWN
  FILE
  LINK
  DIRECTORY
  NONE
  WRITE_DONT_TRUNCATE
  ALLOW_SHARED_READ_WRITE_ACCESS
  SEEK_TO_END
  FULL_DUPLEX
  ASK_FOR_REMOVE_WRITE_PROTECTION
  SCHEME_BASED
  CASE
  PATH_SEGMENT
  UNICODE_DECOMPOSITION
  UNDERLYING
  READONLY
  HIDDEN
  ARCHIVE
  LOCKED
  OWNER_R
  OWNER_W
  OWNER_X
  GROUP_R
  GROUP_W
  GROUP_X
  PUBLIC_R
  PUBLIC_W
  PUBLIC_X
  RW_MASK
  RWX_MASK
  MASK_ALL
  SHOW_IN_EXPLORER
  OPEN_IN_EXPLORER

Variable Documentation

◆  CREATED

CREATED

Creation time of files/directories.

◆  MODIFIED

MODIFIED

Modification time of files/directories.

◆  ACCESSED

ACCESSED

< Last access time of files/directories.

◆  DEFAULT

DEFAULT

Default comparison mode. Urls are case-sensitive.

◆  NORMALIZE

NORMALIZE

Normalizes both operands (via Normalize) before the links are compared with URLCOMPARE::DEFAULT.

◆  IONORMALIZE

IONORMALIZE

Normalizes both operands (via IoNormalize) before the links are compared with URLCOMPARE::DEFAULT.

◆  LEGACY

LEGACY

Activates legacy behavior like in C4D which does case-insensitive comparison on Windows and OS X (but not Linux).

◆  ERRORSTATE

ERRORSTATE

Error code, e.g. IoHandlerInterface not found.

◆  NONEXISTENT

NONEXISTENT

Url doesn't exist.

◆  UNKNOWN

UNKNOWN

Url is of unknown type.

◆  FILE

FILE

Url is a file.

◆  LINK

LINK

Url is a link.

◆  DIRECTORY

DIRECTORY

< Url is a directory, you can use GetBrowseIterator to iterate through the children.

◆  NONE

NONE

No flags set.

No flags.

Just used for internal purposes. Has no effect when used on a resolve function.

◆  WRITE_DONT_TRUNCATE

WRITE_DONT_TRUNCATE

Allows to write to existing files without truncation, so the existing file is kept as is.

◆  ALLOW_SHARED_READ_WRITE_ACCESS

ALLOW_SHARED_READ_WRITE_ACCESS

Allows other threads to read / write the file in parallel. The other instance needs to set this flag also. If you open a file for writing WRITE_DONT_TRUNCATE must be specified at the same time. There are certain limitations under OS X and Linux, see FileLocks .

◆  SEEK_TO_END

SEEK_TO_END

Sets the file handle to the end of file after opening. To append to the end of a file use WRITE_DONT_TRUNCATE | SEEK_TO_END.

◆  FULL_DUPLEX

FULL_DUPLEX

Allows to open streams (tcp) using full duplex where data can be read and sent simultaneously.

◆  ASK_FOR_REMOVE_WRITE_PROTECTION

ASK_FOR_REMOVE_WRITE_PROTECTION

If the file that should be written is write protected the system will ask for checkout/remove flags.

◆  SCHEME_BASED

SCHEME_BASED

If given the scheme decides on his own how the path is resolved. Exclusive flag.

◆  CASE

CASE

The path is put to the canonical form (preferred is lowercase). A given authority is untouched.

◆  PATH_SEGMENT

PATH_SEGMENT

Removes . and .. in case they are full path segments.

◆  UNICODE_DECOMPOSITION

UNICODE_DECOMPOSITION

Normalization for unicode decompositions. Only used by OSX file handler, ignored by other implementations and OS.

◆  UNDERLYING

UNDERLYING

Resolve Url to underlying Url if possible. E.g., an asset Url might get resolved to a file Url.

◆  READONLY

READONLY

Url is read only.

◆  HIDDEN

HIDDEN

Url is hidden.

◆  ARCHIVE

ARCHIVE

Url has archive bit set.

◆  LOCKED

LOCKED

Url is locked (only for Mac, ignored on Windows).

◆  OWNER_R

OWNER_R

Url RWX flags (osx/linux).

◆  OWNER_W

OWNER_W

Url RWX flags (osx/linux).

◆  OWNER_X

OWNER_X

Url RWX flags (osx/linux).

◆  GROUP_R

GROUP_R

Url RWX flags (osx/linux).

◆  GROUP_W

GROUP_W

Url RWX flags (osx/linux).

◆  GROUP_X

GROUP_X

Url RWX flags (osx/linux).

◆  PUBLIC_R

PUBLIC_R

Url RWX flags (osx/linux).

◆  PUBLIC_W

PUBLIC_W

Url RWX flags (osx/linux).

◆  PUBLIC_X

PUBLIC_X

Url RWX flags (osx/linux).

◆  RW_MASK

RW_MASK

Url RW mask (osx/linux).

◆  RWX_MASK

RWX_MASK

Url RWX mask (osx/linux).

◆  MASK_ALL

MASK_ALL

Masks all attributes, e.g. IoSetAttributes(IoGetAttributes(),IOATTRIBUTES::MASK_ALL).

◆  SHOW_IN_EXPLORER

SHOW_IN_EXPLORER

Show the url in the windows explorer or osx finder.

◆  OPEN_IN_EXPLORER

OPEN_IN_EXPLORER

Open the file using the connected app in the operating system.