RtNalGetQueueInfoByHandle

RtNalGetQueueInfoByHandle provides information about a queue reserved by the application.

Syntax

BOOL RtNalGetQueueInfoByHandle(
	RTNAL_QUEUE_HANDLE queueHandle,
	PRTNAL_QUEUE pQueue
);

Parameters

queueHandle

Network queue handle returned by RtNalAcquireQueue.

pQueue

A pointer to a RTNAL_QUEUE structure to be filled in with network 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_HANDLE The argument queueHandle is invalid.
ERROR_INVALID_PARAMETER queueHandle or pQueue is a NULL pointer.
ERROR_NOT_READY RtNalInit has not completed successfully.

Requirements

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

See Also: