servers.done - Function

Delete a tool

Synopsis
done(id, objectid)

Description

The done function closes ie., it calls the destructor, of the C++ object associated with the specified tool. When all the objects that use a server have been shutdown the done function will also shutdown the server.

Once a object has been shutdown it is generally advisable to diasble the tool associated with the C++ object. An example of how this is done is given below.

Arguments

id	Identifies which server to use
	Allowed:	A positive integer obtained from the activate function.
	Default:	no default
objectid	The object to delete.
	Allowed:	The objectid field of the record returned by the create function.
	Default:	no default

Returns
T or a fail

Example

      public.done  := function() {
        wider public, private;
        ok := defaultservers.done(private.serverid, private.toolid.objectid);
        if (ok) {
          val private := F;
          val public := F;
         }
        return ok;
      }

Assuming the toolid and serverid variables have been defined as shown in the examples for the activate or create functions, it is possible to shutdown the tool and perhaps the server using this function.

Next: servers.running - Function Up: servers - Tool Previous: servers.run - Function Contents Index

	Package	utility
	Module	tasking
	Tool	servers