Rtnl2DeletePcpDispatchRule

Rtnl2DeletePcpDispatchRule deletes a dispatch rule previously set up by Rtnl2AddPcpDispatchRule.

Syntax

Copy 
BOOL Rtnl2DeletePcpDispatchRule (
  [in]    RTNL2_HINTERFACE Interface,
  [in]    ULONG RuleId
);

Parameters

[in] Interface

A handle to the interface.

[in] RuleId

The ID of the rule to delete, which is returned by Rtnl2AddPcpDispatchRule.

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_DEVICE_FEATURE_NOT_SUPPORTED

There is no Hardware PCP Dispatcher in this interface.

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • The supplied interface handle is invalid.
  • Or RuleId doesn't correspond to an enabled rule.

ERROR_NOT_READY

The calling process has not called Rtnl2Init.

RTNL2_ERROR_SERIALIZED_COMMAND_TIMEOUT

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

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.

Characteristics

Real-time

Deterministic

No

Shutdown-safe

No
Local memory usage

Process

External MSpace usage

Internal MSpace usage

System

No

No

NL2 process

No

No

Calling process

No

No
Windows contiguous memory usage

Usage

No

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

Rtnl2Api.h

Rtnl2Api.lib

See Also: