Class STGM

The STGM enumeration values are used in the IStorage, IStream, and IPropertySetStorage interfaces. These elements are often combined using an OR operator.

Inheritance

System.Object

STGM

Namespace: Syncfusion.CompoundFile.DocIO.Native

Assembly: Syncfusion.DocIO.Base.dll

Syntax

public sealed class STGM : Enum

Fields

STGM_CONVERT

Creates the new object while preserving existing data in a stream named "Contents".

Declaration

public const STGM STGM_CONVERT

Field Value

Type
STGM

STGM_CREATE

Indicates that an existing storage object or stream should be removed before the new one replaces it.

Declaration

public const STGM STGM_CREATE

Field Value

Type
STGM

STGM_DELETEONRELEASE

Indicates that the underlying file is to be automatically destroyed when the root storage object is released.

Declaration

public const STGM STGM_DELETEONRELEASE

Field Value

Type
STGM

STGM_DIRECT

In direct mode, each change to a storage or stream element is written as it occurs.

Declaration

public const STGM STGM_DIRECT

Field Value

Type
STGM

STGM_DIRECT_SWMR

The STGM_DIRECT_SWMR supports direct mode for single-writer, multireader file operations.

Declaration

public const STGM STGM_DIRECT_SWMR

Field Value

Type
STGM

STGM_FAILIFTHERE

Causes the create operation to fail if an existing object with the specified name exists.

Declaration

public const STGM STGM_FAILIFTHERE

Field Value

Type
STGM

STGM_NOSCRATCH

In transacted mode, a temporary scratch file is usually used to save modifications until the Commit method is called.

Declaration

public const STGM STGM_NOSCRATCH

Field Value

Type
STGM

STGM_NOSNAPSHOT

This flag is used when opening a storage object with STGM_TRANSACTED and without STGM_SHARE_EXCLUSIVE or STGM_SHARE_DENY_WRITE.

Declaration

public const STGM STGM_NOSNAPSHOT

Field Value

Type
STGM

STGM_PRIORITY

Opens the storage object with exclusive access to the most recently committed version.

Declaration

public const STGM STGM_PRIORITY

Field Value

Type
STGM

STGM_READ

Indicates that the object is read-only, meaning that modifications cannot be made.

Declaration

public const STGM STGM_READ

Field Value

Type
STGM

STGM_READWRITE

STGM_READWRITE allows you to both access and modify an object's data.

Declaration

public const STGM STGM_READWRITE

Field Value

Type
STGM

STGM_SHARE_DENY_NONE

Specifies that subsequent openings of the object are not denied read or write access. If no flag from the sharing group is specified, this flag is assumed.

Declaration

public const STGM STGM_SHARE_DENY_NONE

Field Value

Type
STGM

STGM_SHARE_DENY_READ

Prevents others from subsequently opening the object in STGM_READ mode. It is typically used on a root storage object.

Declaration

public const STGM STGM_SHARE_DENY_READ

Field Value

Type
STGM

STGM_SHARE_DENY_WRITE

Prevents others from subsequently opening the object for STGM_WRITE or STGM_READWRITE access.

Declaration

public const STGM STGM_SHARE_DENY_WRITE

Field Value

Type
STGM

STGM_SHARE_EXCLUSIVE

Prevents others from subsequently opening the object in any mode. In transacted mode, sharing of STGM_SHARE_DENY_WRITE or STGM_SHARE_EXCLUSIVE can significantly improve performance since they don't require snapshotting.

Declaration

public const STGM STGM_SHARE_EXCLUSIVE

Field Value

Type
STGM

STGM_SIMPLE

STGM_SIMPLE is a mode that provides a much faster implementation of a compound file in a limited, but frequently used case.

Declaration

public const STGM STGM_SIMPLE

Field Value

Type
STGM

STGM_TRANSACTED

In transacted mode, changes are buffered and written only if an explicit commit operation is called.

Declaration

public const STGM STGM_TRANSACTED

Field Value

Type
STGM

STGM_WRITE

STGM_WRITE lets you save changes to the object, but does not permit access to its data.

Declaration

public const STGM STGM_WRITE

Field Value

Type
STGM