CreateEngine 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.

====== CreateEngine Function     ======


 
==== Description ====
 
Creates a reference to an OpenEngine, running either locally or remotely.
 
==== Syntax ====
 
Error = CreateEngine(Engine, ServerSpec, DatabaseName, Flags, ShutdownSessions)
 
==== Parameters ====
 
The CreateEngine function has the following parameters.

^Parameter^Description^
|//Engine//|Handle for the engine.  Pass null.  CreateEngine will return an engine handle.|
|//ServerSpec//|Descriptor for local or remote server.  Examples:\\ \\ __ServerSpec__ __Description__\\ "" - Use default named pipe on local server\\ .\MYENGINE - Use the named pipe MYENGINE on this machine.\\ 192.168.0.1\MYENGINE - Use the named pipe MYENGINE on the server at 192.168.0.1\\ 192.168.0.1:666\MYENGINE - Use the named pipe MYENGINE on the server at 192.168.0.1, port 666|
|DatabaseName|The database .dbt file to use.|
|Flags|See [[createengine_constants|CreateEngine Constants]].|
|ShutdownSessions|0 - Leave the engine running after this session closes\\ 1 - Causes the engine to shut down sessions when this connection is closed.|

 
==== See Also ====
 
[[closeengine|CloseEngine()]], [[createqueue|CreateQueue()]]
 
==== 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)**
</code>