|
GetStringValue Method
|
|
|
Applies To
|
AdvancedTcl Object
|
|
Prototype
|
GetStringValue(Handle As Long, Value As String, Reserved As Long) As Long
|
|
Input
|
The "Handle" parameter, which is the handle of the string to return.
The "Reserved" parameter, which is reserved for future use and must be zero.
|
|
Output
|
The "Value" parameter, which receives the value of the string.
|
|
Returns
|
The new value (or the old value if it has not been changed) of the "Handle" parameter or TCLB_INVALID_KEY in case of error.
|
|
COM Results
|
S_OK: Success.
E_INVALIDARG: A NULL pointer was passed. |
|
Side Effects
|
None.
|
|
Description
|
This method is used to retrieve the value associated with the specified handle.
The handle returned can be used with the LinkVariable method in conjunction with the variable type of TCL_LINK_STRING to associate a Tcl variable with the string.
|
|
Notes
|
None.
|
|
Example
|
Private Sub Command1_Click()
Dim poTcl As TclBridge.AdvancedTcl Dim plHandle As Long Dim psValue As String Set poTcl = New TclBridge.AdvancedTcl Call poTcl.SetStringValue(plHandle, "test", 0&) psValue = vbNullString Call poTcl.GetStringValue(plHandle, psValue, 0&) Set poTcl = Nothing End Sub |