Rtnl2DestroyPhysicalTxQueueEvent

Rtnl2DestroyPhysicalTxQueueEvent destroys a Transmit event previously created by Rtnl2CreatePhysicalTxQueueEvent, and disables the hardware interrupt associated with the Physical Transmit Queue.

Syntax

Copy 
BOOL Rtnl2DestroyPhysicalTxQueueEvent(
  [in]    RTNL2_HPHYSICAL_TX_QUEUE PhysicalTxQueue, 
  [in]    HANDLE Event
);

Parameters

[in] PhysicalTxQueue

A handle to the Physical Transmit Queue obtained from Rtnl2AcquirePhysicalTxQueue.

[in] Event

The value of the event handle obtained from Rtnl2CreatePhysicalTxQueueEvent.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Possible error codes:

Error code Meaning

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • The supplied Physical Transmit Queue handle is invalid.
  • The Physical Transmit Queue does not have a Transmit event.
  • The supplied value of Event is not the one that the NL2 returned from Rtnl2CreatePhysicalTxQueueEvent.

ERROR_NOT_READY

The calling process has not called Rtnl2Init.

RTNL2_ERROR_NO_MORE_COMMUNICATION

Unable to communicate with the NL2 process. This might be because the NL2 process is not running anymore, or because an application process thread was terminated during a previous call to an NL2 API function.

RTNL2_ERROR_PHYSICAL_TX_QUEUE_IS_RELEASING

Another thread of the calling process is executing Rtnl2ReleasePhysicalTxQueue at the same time.

RTNL2_ERROR_PHYSICAL_TX_QUEUE_NOT_READY

The Physical Transmit Queue is not ready.

RTNL2_ERROR_SERIALIZED_COMMAND_TIMEOUT

The NL2 process didn’t reply within an acceptable delay.

Remarks

After a successful call to this function, the event handle retrieved from Rtnl2CreatePhysicalTxQueueEvent is no longer valid and can't be used as a parameter of RtWaitForSingleObject or RtWaitForMultipleObjects.

Characteristics

Real-time

Deterministic

No
Local memory usage

Process

External MSpace usage

Internal MSpace usage

System

 No Yes. This function will free the memory that was allocated for the Event kernel object in Rtnl2CreatePhysicalTxQueueEvent.

NL2 process

 No No

Calling process

No

No
Contiguous memory usage

Usage

No

Requirements

Minimum supported version Header Library

eRTOS 1.0 SDK

Rtnl2Api.h

Rtnl2Api.lib

See Also: