Rtnl2GetMsixMessageConfig

Rtnl2GetMsixMessageConfig retrieves the configuration of an MSI-X message.

Syntax

Copy 
BOOL Rtnl2GetMsixMessageConfig(
  [in]    RTNL2_HINTERFACE Interface,
  [in]    ULONG MessageId,
  [out]   RTNL2_MSIX_MESSAGE_CONFIG *pConfig,
  [in]    ULONG ConfigStructSize
);

Parameters

[in] Interface

A handle to the interface.

[in] MessageId

The message ID of the MSI-X message.

[out] pConfig

A pointer to an RTNL2_MSIX_MESSAGE_CONFIG structure allocated by the caller. The NL2 populates this structure with the current settings of the MSI-X message.

[in] ConfigStructSize

The size of the RTNL2_MSIX_MESSAGE_CONFIG structure allocated by the caller.

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_NOT_READY

The calling process has not called Rtnl2Init.

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • The supplied Interface handle is invalid.
  • MessageId is greater or equal to the total number of MSI-X Messages.
  • pConfig is NULL while ConfigStructSize is a non-zero value.

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.

Remarks

The caller MUST set ConfigStructSize to sizeof(RTNL2_MSIX_MESSAGE_CONFIG) to ensure backward and forward compatibility.

Characteristics

Real-time

Deterministic

No
Local memory usage

Process

External MSpace usage

Internal MSpace usage

System

No

No

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: