RtNalGetQueueInfoByIndex

RtNalGetQueueInfoByIndex provides information about a queue.

Syntax

BOOL RtNalGetQueueInfoByIndex(
	ULONG index,
	PRNAL_QUEUE pQueue
);

Parameters

Index

System index of the network queue. You can find the total system number of queues by calling RtNalGetNumberOfQueues.

pQueue

Pointer to a RTNAL_QUEUE network queue information structure to be filled in with the queue information. This parameter cannot be NULL.

Return Value

Returns TRUE if the call succeeds. Otherwise it returns FALSE. Call GetLastError to obtain an error code. The possible error codes are listed below:

Error Code	Meaning
ERROR_INVALID_PARAMETER	pQueue is a NULL pointer.
ERROR_NOT_FOUND	The index is larger than the total number of queues configured in the system.
ERROR_NOT_READY	RtNalInit has not completed successfully.

Remarks

The queue does not have to be reserved by RtNalAcquireQueue. An application can call this function sequentially starting with index 0 and incrementing index to iterate through all of the network queue objects configured by the NAL. You can find the number of queues by calling RtNalGetNumberOfQueues.

Requirements

Minimum Supported Version	RTX64 4.0
Header	rtnapi.h, RtNalApi.h
Library	RtNal.lib