CloseEngine Function [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== CloseEngine Function     ======


 
==== Description ====
 
Closes an OpenEngine handle referenced by [[createengine|CreateEngine()]].

The connection will close. The behavior of the engine will depend on the flags passed in the call to [[createengine|CreateEngine()]].
 
==== Syntax ====
 
Error = CloseEngine(Engine)
 
==== Parameters ====
 
The CloseEngine function has the following parameter.

^Parameter^Description^
|//Engine//|Handle for the engine created by [[createengine|CreateEngine()]].||

 
==== See Also ====
 
[[createengine|CreateEngine()]]
 
==== Example ====
 
<code>
// Create an engine that will not shut down when the connections end
// Uses the named pipe REVCAPI_TEST

Error = CreateEngine(Engine, "\\.\REVCAPI_TEST",  "EXAMPLES",**CREATE_ENGINE_OPEN_ALWAYS$,  1)

// keep the engine open as long as necessary...

Error = CloseEngine(Engine)
</code>