IMcImage2SetImageStateUserFlags Method
|
|
Sets or clears one or more of the user-settable flags in the ImageState property.
Namespace:
MediaCy.IQL.Engine
Assembly:
MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
SyntaxSub SetImageStateUserFlags (
Optional FrameIndex As Integer = -3,
Optional UserFlagsMask As mcImageStateFlags = mcImageStateFlags.mcisfSettableUserFlagsMask,
Optional NewUserFlags As mcImageStateFlags = mcImageStateFlags.mcisfNoFlags
)
Parameters
- FrameIndex (Optional)
- Type: SystemInt32
Frame index with which the assigned flag(s) should be associated. If
McWholeImage (the default), then the assigned flags are associated with all frames,
otherwise the flags are only associated with the specified frame. Currently, only
McWholeImage is supported. - UserFlagsMask (Optional)
- Type: MediaCy.IQL.EnginemcImageStateFlags
A mask for the bits being assigned. Bits outside of the
mcImageStateFlags.mcisfSettableUserFlagsMask (which is the default value for this
argument) are illegal. - NewUserFlags (Optional)
- Type: MediaCy.IQL.EnginemcImageStateFlags
Bits to set or clear, as masked by the UserFlagsMask argument. Bits
outside of the mcImageStateFlags.mcisfSettableUserFlagsMask are illegal.
RemarksThis method sets or clears one of the top four bits in the ImageState property.
The assigned user-flags are either associated with all frames or with a given single frame
(currently frame-specfic user-set flags are not supported).
See Also