Platforms to show: All Mac Windows Linux Cross-Platform
Back to WIAStreamMBS class.
WIAStreamMBS.kCommitConsolidate = 8
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Windows 2000 and Windows XP: Indicates that a storage should be consolidated after it is committed, resulting in a smaller file on disk. This flag is valid only on the outermost storage object that has been opened in transacted mode. It is not valid for streams. The kCommitConsolidate flag can be combined with any other kCommit* flags.
WIAStreamMBS.kCommitDangerouslyCommitMerelyToDiskCache = 4
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Commits the changes to a write-behind disk cache, but does not save the cache to the disk. In a write-behind disk cache, the operation that writes to disk actually writes to a disk cache, thus increasing performance. The cache is eventually written to the disk, but usually not until after the write operation has already returned. The performance increase comes at the expense of an increased risk of losing data if a problem occurs before the cache is saved and the data in the cache is lost.
If you do not specify this value, then committing changes to root-level storage objects is robust even if a disk cache is used. The two-phase commit process ensures that data is stored on the disk and not just to the disk cache.
WIAStreamMBS.kCommitDefault = 0
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
You can specify this condition with kCommitConsolidate, or some combination of the other three flags in this list of elements. Use this value to increase the readability of code.
WIAStreamMBS.kCommitOnlyIfCurrent = 2
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Prevents multiple users of a storage object from overwriting each other's changes. The commit operation occurs only if there have been no changes to the saved storage object because the user most recently opened it. Thus, the saved version of the storage object is the same version that the user has been editing. If other users have changed the storage object, the commit operation fails and returns the STG_E_NOTCURRENT value. To override this behavior, call the Commit method again using the kCommitDefault value.
WIAStreamMBS.kCommitOverwrite = 1
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
The commit operation can overwrite existing data to reduce overall space requirements. This value is not recommended for typical usage because it is not as robust as the default value. In this case, it is possible for the commit operation to fail after the old data is overwritten, but before the new data is completely committed. Then, neither the old version nor the new version of the storage object will be intact.
You can use this value in the following cases:
- The user is willing to risk losing the data.
- The low-memory save sequence will be used to safely save the storage object to a smaller file.
- A previous commit returned STG_E_MEDIUMFULL, but overwriting the existing data would provide enough space to commit changes to the storage object.
Be aware that the commit operation verifies that adequate space exists before any overwriting occurs. Thus, even with this value specified, if the commit operation fails due to space requirements, the old data is safe. It is possible, however, for data loss to occur with the kCommitOverwrite value specified if the commit operation fails for any reason other than lack of disk space.
WIAStreamMBS.kModeConvert = &h20000
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Creates the new object while preserving existing data in a stream named "Contents". In the case of a storage object or a byte array, the old data is formatted into a stream regardless of whether the existing file or byte array currently contains a layered storage object. This flag can only be used when creating a root storage object. It cannot be used within a storage object; for example, in CreateStream. It is also not valid to use this flag and the kModeDeleteOnRelease flag simultaneously.
WIAStreamMBS.kModeCreate = &h1000
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Undicates that an existing storage object or stream should be removed before the new object replaces it. A new object is created when this flag is specified only if the existing object has been successfully removed.
This flag is used when attempting to create:
- A storage object on a disk, but a file of that name exists.
- An object inside a storage object, but a object with the specified name exists.
- A byte array object, but one with the specified name exists.
WIAStreamMBS.kModeDeleteOnRelease = &h4000000
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Indicates that the underlying file is to be automatically destroyed when the root storage object is released. This feature is most useful for creating temporary files.
WIAStreamMBS.kModeFailIfThere = 0
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Causes the create operation to fail if an existing object with the specified name exists. In this case, STG_E_FILEALREADYEXISTS is returned. This is the default creation mode; that is, if no other create flag is specified, kModeFailIfThere is implied.
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Indicates that the object is read-only, meaning that modifications cannot be made.
WIAStreamMBS.kModeReadWrite = 2
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Enables access and modification of object data.
WIAStreamMBS.kModeShareDenyExclusive = &h10
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Prevents others from subsequently opening the object in any mode. Be aware that this value is not a simple bitwise OR operation of the kModeShareDenyRead and kModeShareDenyWrite values. In transacted mode, sharing of kModeShareDenyWrite or kModeShareDenyExclusive can significantly improve performance because they do not require snapshots. For more information about transactioning, see the Remarks section.
WIAStreamMBS.kModeShareDenyNone = &h40
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
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.
WIAStreamMBS.kModeShareDenyRead = &h30
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Prevents others from subsequently opening the object in STGM_READ mode. It is typically used on a root storage object.
WIAStreamMBS.kModeShareDenyWrite = &h20
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Prevents others from subsequently opening the object for kModeShareWrite or kModeShareReadWrite access. In transacted mode, sharing of kModeShareDenyWrite or kModeShareDenyExclusive can significantly improve performance because they do not require snapshots.
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
Enables you to save changes to the object, but does not permit access to its data.
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
The new seek pointer is an offset relative to the current seek pointer location. In this case, the dlibMove parameter is the signed displacement from the current seek position.
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
The new seek pointer is an offset relative to the end of the stream. In this case, the dlibMove parameter is the new seek position relative to the end of the stream.
Type | Topic | Plugin | Version |
const | Image Capture | MBS Win Plugin | 10.3 |
The new seek pointer is an offset relative to the beginning of the stream. In this case, the dlibMove parameter is the new seek position relative to the beginning of the stream.
The items on this page are in the following plugins: MBS Win Plugin.