EngDestroyEngine

Destroys an engine instance.

Syntax

PULSE_STATUS EngDestroyEngine(
 [in] PPS_ENGINE pEngine
);

Parameters

PPS_ENGINE pEngine

An opaque handle to an engine created by the EngCreateEngine function.

Return value

If the function succeeds, the return value is PULSE_STATUS_SUCCESS.

If it fails, it returns one of the PULSE_STATUS values. Possible return codes include, but are not limited to, the following:

PULSE_STATUS_INVALID_PARAMETER
0xC0000010		 pEngine argument is NULL.

Remarks

Stops the engine if it was running.

Detaches any assigned transport.