Functions
	save_variable interp pname index name value

	load_variable interp pname index name

	is_exposed interp pname name

	exec_exposed interp pname name args

	reload interp pname

	get_header_info interp pname attr

Function Documentation

§ exec_exposed()

api::plugin::exec_exposed			interp pname name args

Executes the exposed procedure (if it exists) and returns the value returned by the procedure. If the procedure does not exist or there is an exception thrown by the procedure, a value of -1 will be returned to the calling method.

Definition at line 887 of file api.tcl.

     proc exec_exposed {interp pname name args} {
 
       if {[plugins::is_exposed $name] && ![catch { plugins::execute_exposed $name {*}$args} retval]} {
         return $retval
       }
 
       return -1
 
     }

§ get_header_info()

api::plugin::get_header_info			interp pname attr

Returns the value of the requested field from the header.tkedat file associated with the calling plugin.

The supported values for the 'attr' parameter are the following:

name
display_name
author
email
website
version
trust_required
description
category

Definition at line 920 of file api.tcl.

     proc get_header_info {interp pname attr} {
 
       return [plugins::get_header_info $pname $attr]
 
     }

§ is_exposed()

api::plugin::is_exposed			interp pname name

Returns a value of true if the given procedure has been exposed by another plugin. The value of "name" should be in the form of: <plugin_name>::<procedure_name>

Definition at line 876 of file api.tcl.

     proc is_exposed {interp pname name} {
 
       return [plugins::is_exposed $name]
 
     }

§ load_variable()

api::plugin::load_variable			interp pname index name

Retrieves the value of the named variable from non-corruptible memory (from a previous save_variable call.

Parameters

index	Unique value that is passed to the on_reload retrieve command.
name	Name of the variable to get the value of. If the named variable could not be found), an empty string is returned.

Definition at line 866 of file api.tcl.

     proc load_variable {interp pname index name} {
 
       return [plugins::restore_data $index $name]
 
     }

§ reload()

api::plugin::reload			interp pname

Reloads the plugins. This is useful if the plugin changes its own code at runtime and needs to re-source itself.

Definition at line 900 of file api.tcl.

     proc reload {interp pname} {
 
       plugins::reload
 
     }

§ save_variable()

api::plugin::save_variable			interp pname index name value

Saves the value of the given variable name to non-corruptible memory so that it can be later retrieved when the plugin is reloaded.