STGM class enum
The STGM constants are flags that indicate conditions for creating and deleting the object and access modes for the object.
Constructors
- STGM()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- STGM_CONVERT → const int
- Creates the new object while preserving existing data in a stream named "Contents".
- STGM_CREATE → const int
- Indicates that an existing storage object or stream should be removed before the new object replaces it.
- STGM_DELETEONRELEASE → const int
- Indicates that the underlying file is to be automatically destroyed when the root storage object is released.
- STGM_DIRECT → const int
- Indicates that, in direct mode, each change to a storage or stream element is written as it occurs.
- STGM_DIRECT_SWMR → const int
- Supports direct mode for single-writer, multireader file operations.
- STGM_FAILIFTHERE → const int
- Causes the create operation to fail if an existing object with the specified name exists.
- STGM_NOSCRATCH → const int
- Indicates that, in transacted mode, a temporary scratch file is usually used to save modifications until the Commit method is called.
- STGM_NOSNAPSHOT → const int
- This flag is used when opening a storage object with STGM_TRANSACTED and without STGM_SHARE_EXCLUSIVE or STGM_SHARE_DENY_WRITE.
- STGM_PRIORITY → const int
- Opens the storage object with exclusive access to the most recently committed version.
- STGM_READ → const int
- Indicates that the object is read-only, meaning that modifications cannot be made.
- STGM_READWRITE → const int
- Enables access and modification of object data.
- STGM_SHARE_DENY_NONE → const int
- Specifies that subsequent openings of the object are not denied read or write access.
- STGM_SHARE_DENY_READ → const int
- Prevents others from subsequently opening the object in STGM_READ mode. It is typically used on a root storage object.
- STGM_SHARE_DENY_WRITE → const int
-
Prevents others from subsequently opening the object for
STGM_WRITE
orSTGM_READWRITE
access. - STGM_SHARE_EXCLUSIVE → const int
- Prevents others from subsequently opening the object in any mode.
- STGM_SIMPLE → const int
- Provides a faster implementation of a compound file in a limited, but frequently used, case. For more information, see the Remarks section.
- STGM_TRANSACTED → const int
- Indicates that, in transacted mode, changes are buffered and written only if an explicit commit operation is called.
- STGM_WRITE → const int
- Enables you to save changes to the object, but does not permit access to its data.