|
GetInterpreterList Method
|
|
|
Applies To
|
BasicTcl Object, AdvancedTcl Object
|
|
Prototype
|
GetInterpreterList(InterpreterList As Variant, Global As Long, Flags As Long, Reserved As Long) As Long
|
|
Input
|
The "InterpreterList" parameter, which must be empty.
The "Global" parameter, which determines the interpreter list to return.
The "Flags" parameter, which is reserved for future use and must be zero.
The "Reserved" parameter, which is reserved for future use and must be zero.
|
|
Output
|
The "InterpreterList" parameter is modified to contain the specified interpreter list.
|
|
Returns
|
The number of interpreters in the list (including the "dummy" or "zero" interpreter).
|
|
COM Results
|
S_OK: Success.
E_INVALIDARG: Either a NULL pointer was passed or the "InterpreterList" parameter is not empty. E_OUTOFMEMORY: A string, variant, or array could not be allocated. |
|
Side Effects
|
None.
|
|
Description
|
If the "Global" parameter is non-zero, the global interpreter list is returned.
The global interpreter list contains all active interpreters from all active BasicTcl objects.
If the "Global" parameter is zero, the local interpreter list is returned.
The local interpreter list contains all active interpreters from the active BasicTcl object.
|
|
Notes
|
The returned list contains an extra element with a value of zero.
This behavior is by design.
Please ignore this element during any processing that needs to be done on valid interpreters.
|
|
Example
|
Private Sub Command1_Click()
Dim poTcl As TclBridge.BasicTcl Dim pvInterpreterList As Variant Dim plCount As Long Set poTcl = New TclBridge.BasicTcl pvInterpreterList = Empty ' must be empty plCount = poTcl.GetInterpreterList(pvInterpreterList, False, 0&, 0&) ' a one-element list will be returned ' since this object is brand new Set poTcl = Nothing End Sub |