Dervish Tcl Procedures

handleBindNew

Return a new handle, bound to <addr>, type <type>

Warning: if <addr> is incorrect or even NULL (0x0) dervish might core dump upon the use of the new handle.

TCL SYNTAX: handleBindNew <addr> <type> <addr> The desired address, e.g. 0x1234 <type> The type pointed to by that address, e.g. FOO RETURNS: TCL_OK Successful completion. Returns the handle (e.g. h4) TCL_ERROR Error occurred.

handleDup

Return a new handle whose contents (pointer and type) are the same as <handle>

TCL SYNTAX: handleDup <handle> <handle> The name of a handle, e.g. h11 RETURNS: TCL_OK Successful completion. Returns a new handle, e.g. h23 TCL_ERROR Error occurred.

handleNew

Return a new handle; it is initialised to (NULL, UNKNOWN).

TCL SYNTAX: handleNew RETURNS: TCL_OK Successful completion. Returns the name of the new handle. TCL_ERROR Error occurred.



handlePtr

Return a handle's pointer.

TCL SYNTAX: handlePtr <handle> <handle> The name of a handle, e.g. h11 RETURNS: TCL_OK Successful completion. Returns an address, e.g. 0x1234af TCL_ERROR Error occurred.

handleType

Return a handle's type.

TCL SYNTAX: handleType <handle> <handle> The name of a handle, e.g. h11 RETURNS: TCL_OK Successful completion. Returns type, e.g. REGION TCL_ERROR Error occurred.

handleListFromType

Return a Tcl list of the handle names that are attached to a structure of the given type (i.e. REGION, PT, HDR... ). This is a Tcl procedure.

TCL SYNTAX: handleListFromType <type> >type> An ASCII type.

hdrNew

A TCL expression to create a new empty header. This command is actually an alias in dervishStartup.tcl for handleNewFromType HDR.

TCL SYNTAX: hdrNew RETURNS: TCL_OK Successful completion. The Interp result string contains the name of the handle that was created. TCL_ERROR Error occurred. Depending on the nature of the error, the Interp result string will contain an appropriate message.



hdrDel

A TCL expression to delete a header. This command is actually an alias in dervishStartup.tcl for handleDelFromType.

TCL SYNTAX: hdrDel <handle> <handle> handle to a header RETURNS: TCL_OK Successful completion. TCL_ERROR Error occurred. Depending on the nature of the error, the Interp result string will contain an appropriate message.



regListNames

Return a Tcl list of the handle names that are attached to a region. This Tcl procedure uses handleListFromType.

TCL SYNTAX: regListNames



schemaMemberGet

Get an element of a schema of the given type TCL SYNTAX: schemaMemberGet <type> <elem> <type> The type of the schema to get <elem> The element of the schema to return RETURNS: TCL_OK Successful completion. Returns the element schema. TCL_ERROR Error occurred.

shMemTest

On error returns a list where the first element is a list of the handles that were not freed, and the second element is a list of the memory blocks that have not been freed. Only memory obtained using shMalloc will appear on this list. If no memory is left hanging around, nothing is returned. TCL SYNTAX: shMemTest RETURNS: TCL_OK Successful completion. TCL_ERROR Error occurred.

tblColNew

_______________________________________________________________________________ NAME tblColNew - Return a handle to a new tblCol. SYNOPSIS (Tcl Syntax) tblColNew ARGUMENTS none RETURN VALUES TCL_OK Success. Successful completion. The interp result string contains the name of the created handle. TCL_ERROR Failure. The interp result string contains an error message. _______________________________________________________________________________ DESCRIPTION

This extension will create a new handle pointing to a new tblCol structure. In fact this Tcl extensions is actually aliased to the following command:

     handleNewFromType TBLCOL

tblColDel

_______________________________________________________________________________ NAME tblColDel - Delete the TBLCOL structure pointed to by the passed handle. SYNOPSIS (Tcl Syntax) tblColDel <handle> ARGUMENTS handle The TBLCOL Table handle. RETURN VALUES TCL_OK Success. Successful completion. TCL_ERROR Failure. The interp result string contains an error message. _______________________________________________________________________________ DESCRIPTION

This extension will delete the TBLCOL structure pointed to by a handle. In fact this Tcl extensions is actually aliased to the following command:

     handleDelFromType