TCLBCommandOptions Enumeration
|
|
Description
|
|
TclBridge command option values (may be combined).
|
|
Values
|
|
TCLB_cINVALID
|
Invalid combination of command options.
|
TCLB_cNONE
|
No command options are set.
This value should not be returned by the GetCommandOptions method.
|
TCLB_cUSED
|
Command slot is used (this will always be set for valid custom commands).
|
TCLB_cJOIN
|
Join command arguments together into one string.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cSTRING
|
Evaluate as a string.
Used with the Evaluate method.
|
TCLB_cFILE
|
Evaluate as a file.
Used with the Evaluate method.
|
TCLB_cGLOBAL
|
Evaluate in the global context.
Used with the Evaluate method.
|
TCLB_cEXCEPTIONS
|
|
TCLB_cASYNCHRONOUS
|
Evaluate the string or file asynchronously and fire the EvaluateComplete event upon completion of the evaluation.
Used with the Evaluate method.
Please note that only one asynchronous evaluation per interpreter can be pending at any one time.
|
TCLB_cNOTIFY
|
Fire the EvaluateComplete event upon completion of the evaluation.
Used with the Evaluate method.
|
TCLB_cDEBUG
|
Show (on the debug console) when this command is issued from a Tcl interpreter.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cDELETE
|
Delete the interpreter when the evaluation completes.
Normally, this is used in conjunction with asynchronous evaluation.
Used with the Evaluate method.
|
TCLB_cOBJECT
|
Constructs a Tcl "string object" and evaluates it.
Used with the Evaluate method.
|
TCLB_cDIRECT
|
Force evaluation without compilation.
This currently does nothing unless it is used with the TCLB_cOBJECT flag.
Used with the Evaluate method.
|
TCLB_cENABLED
|
Determines or sets whether or not the custom command is currently enabled.
Commands that are disabled will cause a Tcl error and will not be invoked.
Commands are automatically set to be enabled when they are first created.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cPENDING
|
Determines whether or not the custom command is currently in use (pending).
Setting this flag with the SetCommandOptions method is not recommended.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cRECURSION
|
Determines or sets whether or not the custom command is re-entrant.
Setting this flag allows your custom command to be called from inside itself.
Use this flag with care.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cREENTRANT
|
Currently, this flag is defined to be the same as TCLB_cRECURSION.
|
TCLB_cSAFE
|
Determines or sets whether or not the custom command may be executed in a "safe" interpreter.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cUSER
|
This flag is reserved for the application developer.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cLOCK
|
Lock the interpreter from access by other threads during the evaluation.
Used with the Evaluate method.
|
TCLB_cARRAY
|
Put command arguments into an array of strings.
Used with the GetCommandOptions and SetCommandOptions methods.
|
TCLB_cDYNAMIC
|
Custom command is "dynamic" and uses a ProgID rather than an existing object instance.
The object(s) are created and destroyed as necessary and CANNOT expect to maintain any internal state information between calls to the custom command.
This flag is automatically set, if required, based on whether the CreateCommand or CreateDynamicCommand method added the custom command.
|
TCLB_cRESERVED
|
Reserved option, do not use.
|