IMcImageStorageOpenStorage Method
|
|
Open the image storage.
Namespace:
MediaCy.IQL.Engine
Assembly:
MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
SyntaxSub OpenStorage (
ImageType As McImageType,
Width As Integer,
Height As Integer,
FrameCount As Integer,
StartingFrameIndex As Integer
)
Parameters
- ImageType
- Type: MediaCy.IQL.EngineMcImageType
Type of image to be stored. This will be the NaturalImageType property. - Width
- Type: SystemInt32
Width of each frame. - Height
- Type: SystemInt32
Height of each frame. - FrameCount
- Type: SystemInt32
Number of frames. - StartingFrameIndex
- Type: SystemInt32
Index of first stored frame for the FrameIndex argument
in calls to SizeClosestSubsampledSubFrame, ReadSubsampledSubFrame and WriteSubFrame.
RemarksThe method takes no storage information (e.g., a file name), since
each McImageStorage is responsible for knowing where its own storage is located.
Always check IsStorageOpen before calling Open, since some instances of McImageStorage
may already have been opened. In this case, you can find the type of storage by
calling NaturalImageType and the dimensions of the storage by calling the
GetDimensions method.
If the mciscCanExtendSize Capabilities property bit is set, then OpenStorage can be called
with a FrameCount larger than the existing frame count as returned by GetStorageDimension.
In this case, the ImageType, Width and Height arguments are ignored; it is the caller's
responsibility to ensure that the frames the storage is being extended for are of the
same type and dimensions as those specified in the original call to OpenStorage.
Call CloseStorage when you are through with it, and before you try to reopen the storage
for fresh use.
See AlsoReference
GetStorageDimension