EngAssignTransport

Assigns a transport to the engine instance.

Syntax

PULSE_STATUS EngAssignTransport(
 [in] PPS_ENGINE pEngine,
 [in] PPS_TRANSPORT pTransport
);

Parameters

PPS_ENGINE pEngine

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

PPS_TRANSPORT pTransport

An opaque handle to a transport created by the TransportCreate 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_INSUFFICIENT_RESOURCES
0xC0000002		 One of the memory allocations failed during initialization.
PULSE_STATUS_INVALID_PARAMETER
0xC0000010		 Might happen if
  • pEngine argument is NULL.
  • pTransport argument is NULL.
PULSE_STATUS_TRANSPORT_INIT_FAILED
0xC0000300		 The transport was not initialized before being assigned to the engine.

Remarks

The engine cannot be used without a transport. If this function is successful, the engine is ready to be started with the EngStart function.

The transport should be initialized before use. A transport is considered initialized after a successful call to the TransportSetInterfaceName or TransportSetInterfaceIndex function.

Any previously attached transport will be detached before assigning the new transport. In this case, the engine will be stopped if it was running.