Table of Contents

CloseEngine Function
- - Description
  - Syntax
  - Parameters
  - See Also
  - Example

CloseEngine Function

Description

Closes an OpenEngine handle referenced by CreateEngine().

The connection will close. The behavior of the engine will depend on the flags passed in the call to CreateEngine().

Syntax

Error = CloseEngine(Engine)

Parameters

The CloseEngine function has the following parameter.

Parameter	Description
Engine	Handle for the engine created by CreateEngine().

See Also

Example

// 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)