RtndQueryInterfaceCapability
RtndQueryInterfaceCapability gets a given capability of an interface.
Syntax
BOOL RtndQueryInterfaceCapability(
[in] ULONG_PTR RtndInterfaceId,
[in] ULONG QueueIndex,
[in] RTND_CAPABILITY_ID CapabilityId,
[in] VOID *pCapabilityData,
[in] ULONG CapabilityStructSize
);
Parameters
[in] RtndInterfaceId
The number or pointer used to identify the interface. This value is returned by RtndManageInterface.
[in] QueueIndex
The target index of the Transmit or Receive queue. This parameter is ignored if the operation is at the interface level.
[in] CapabilityId
The identifier of the capability type to query.
[in] pCapabilityData
The address of the capability structure. The exact type depends on the capability type.
[in] CapabilityStructSize
The size of the structure pointed to by pCapabilityData.
Return Value
If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.
Common error codes:
| Error code | Meaning |
|---|---|
|
ERROR_NOT_SUPPORTED |
The requested capability identified by CapabilityId is not supported by this driver. |
Note: Custom drivers may return other error codes not listed above.
Remarks
The NL2 always calls this function from the main thread of the NL2 process.
To ensure backward and forward compatibility, the NL2 always uses sizeof to get the size of its capability structure at compilation time and zeros out the structure before calling this function.
Characteristics
| Real-time requirements | ||
|
Deterministic behavior |
Not required |
|
| Local memory allocation/deallocation restrictions | ||
|
Process |
External MSpace |
Internal MSpace |
|
System |
Allowed |
Allowed |
|
Process |
Allowed |
Allowed |
| Contiguous memory allocation/deallocation restrictions | ||
|
Contiguous memory |
Allowed |
|
Requirements
| Minimum supported version | Header |
|---|---|
|
eRTOS 1.0 SDK |
Rtnd.h |
See Also: