|
SetStringValue Method
|
|
|
Applies To
|
AdvancedTcl Object
|
|
Prototype
|
SetStringValue(Handle As Long, Value As String, Reserved As Long) As Long
|
|
Input
|
The "Handle" parameter, which is the handle of the string to change or TCLB_INVALID_KEY to add a new string.
The "Value" parameter, which is the new value to add or change (if this parameter is NULL, the string is deleted).
The "Reserved" parameter, which is reserved for future use and must be zero.
|
|
Output
|
The "Handle" parameter, which receives a new handle in case the value TCLB_INVALID_KEY was specified initially.
|
|
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 set the value associated with the specified handle.
Alternatively, it is used to create a new string and return the associated 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 |