vbAccelerator - Contents of code file: IPluginConfiguration.cls

This file is part of the download VB5 CD Ripper Plugin Interface, which is described in the article CD Ripping in VB Part 2.

VERSION 1.0 CLASS
BEGIN
  MultiUse = -1  'True
END
Attribute VB_Name = "IPluginConfig"
Attribute VB_GlobalNameSpace = False
Attribute VB_Creatable = True
Attribute VB_PredeclaredId = False
Attribute VB_Exposed = True
Option Explicit

''' <summary>
''' Gets number of parameters for this plugin
''' </summary>
''' <return>Number of parameters</return>
Public Property Get ParameterCount() As Long
Attribute ParameterCount.VB_Description = "Gets the number of parameters for
 this plugin."

End Property

''' <summary>
''' Gets name of a specified parameter
''' </summary>
''' <param name="locale">Current locale e.g. en-us</param>
''' <param name="paramNumber">1-based index of parameter</param>
''' <return>Name of the parameter</return>
Public Property Get ParameterName(ByVal locale As String, ByVal paramNumber As
 Long) As String
Attribute ParameterName.VB_Description = "Gets the name of the parameter with
 the specified index."

End Property

''' <summary>
''' Get number of possible values for a parameter.  Returning 0 causes the
''' parameter to be disabled.
''' </summary>
''' <param name="paramNumber">1-based index of parameter</param>
''' <return>Number of parameters</return>
Public Property Get ParameterValueCount(ByVal paramNumber As Long) As Long
Attribute ParameterValueCount.VB_Description = "Gets the number of values for
 the parameter with the specified index."

End Property

''' <summary>
''' Get name of a parameter value
''' </summary>
''' <param name="locale">Current locale e.g. en-us</param>
''' <param name="paramNumber">1-based index of parameter</param>
''' <param name="valueNumber">1-based index of value</param>
''' <return>Name of the parameter value</return>
Public Property Get ParameterValueName(ByVal locale As String, ByVal
 paramNumber As Long, ByVal valueNumber As Long) As String
Attribute ParameterValueName.VB_Description = "Gets the name of the value for
 the specified parameter value."

End Property

''' <summary>
''' Get the default value for a parameter
''' </summary>
''' <param name="paramNumber">1-based index of parameter</param>
''' <return>1-based index of the default parameter value</return>
Public Property Get ParameterDefaultValue(ByVal valueNumber As Long) As Long
Attribute ParameterDefaultValue.VB_Description = "Gets the default value index
 for the specified parameter index."

End Property

''' <summary>
''' Called when a parameter's value is set
''' </summary>
''' <param name="locale">Current locale e.g. en-us</param>
''' <param name="paramNumber">1-based index of parameter</param>
''' <param name="valueNumber">1-based index of value</param>
''' <param name="changedParameterIndex">Optional: if setting this value causes
 the list
''' of options for another parameter to change, then this should be set to an
 array
''' of indexes of the parameters that have changed.</param>
Public Sub SetParameterValue( _
      ByVal locale As String, _
      ByVal paramNumber As Long, _
      ByVal valueNumber As Long, _
      ByRef changedParameterIndexes As Variant _
   )
Attribute SetParameterValue.VB_Description = "Called by the client when a
 parameter value is changed."

End Sub