IMcStreamGetAdditionalOptions Method
|
|
BSTR *Description, mcsovtValueType* ValueType,
mcsguiGuiRepresentation* GuiRep, VARIANT* ValueMin, VARIANT* ValueMax,
VARIANT* DefaultValue, long* PropertyID)
This method allows an application to query for any additional options that
can be set for Saving a file to the specific format.
Namespace:
MediaCy.IQL.IO
Assembly:
MediaCy.IQL.IO (in MediaCy.IQL.IO.dll) Version: 10.0.6912.0
SyntaxSub GetAdditionalOptions (
<OutAttribute> ByRef OptionNumber As Integer,
Format As String,
Mode As mcfmFileMode,
<OutAttribute> ByRef Description As String,
<OutAttribute> ByRef ValueType As mcsovtValueType,
<OutAttribute> ByRef GuiRep As mcsguiGuiRepresentation,
<OutAttribute> ByRef ValueMin As Object,
<OutAttribute> ByRef ValueMax As Object,
<OutAttribute> ByRef DefaultValue As Object,
<OutAttribute> ByRef PropertyID As Integer
)
Parameters
- OptionNumber
- Type: SystemInt32
- Format
- Type: SystemString
- Mode
- Type: MediaCy.IQL.IOmcfmFileMode
- Description
- Type: SystemString
- ValueType
- Type: MediaCy.IQL.IOmcsovtValueType
- GuiRep
- Type: MediaCy.IQL.IOmcsguiGuiRepresentation
- ValueMin
- Type: SystemObject
- ValueMax
- Type: SystemObject
- DefaultValue
- Type: SystemObject
- PropertyID
- Type: SystemInt32
RemarksOptionNumber - this should initially be set to 0. If there are more options available,
it will be set to the total. A subsequent call could then set this
number to 1, 2, etc... until all options are retrieved.
Format - The textual indicator (usually extension) for the Stream to be queried.
Description - A textual description for the Save Option.
ValueType - Indicates how the option value needs to be saved.
Currently can be one of the following:
mcsovtInteger = 0,
mcsovtFloat = 1,
mcsovtString = 2
GuiRep - A suggestion as to how this value should be presented to the user.
For example, a compression level would be best represented as a Slider,
while a Descriptor file could be best represented as a File Open dialog.
Currently can be one of the following:
mcsguiSlider = 0,
mcsguiEdit = 1, a Textual entry box
mcsguiFile = 2, a File Open dialog
ValueMin - The minimum value, in ValueType format, acceptable
ValueMax - The maximum value, in ValueType format, acceptable
DefaultValue - A reasonable suggestion by the library for a default value.
PropertyID - The DISPID that can be used to set this property with the users
input. Use McStream->Subclass->Invoke(PropertyID, ...).
See AlsoReference
[T:MediaCy.IQL.IO.Subclass()]