GetNotification method

Block for notification or timeout. Returns event name or null.

Syntax

Visual Basic

Public Function GetNotification( _
   ByVal queueName As String, _
   ByVal wait_ms As UInt64 _
) As String

C#

public string  GetNotification(
   string  queueName,
   ulong wait_ms
);

Parameters

queueName The name of the queue which will be waited upon.
wait_ms The time to wait, in milliseconds. Use (ulong)-1 for an indefinite wait.

Remarks

Read an event notification. This call blocks until a notification is received or until the given wait period expires. To wait indefinitely, pass UL_READ_WAIT_INFINITE for \p wait_ms. To cancel a wait, send another notification to the given queue or use CancelGetNotification(). After reading a notification, use ReadNotificationParameter() to retrieve additional parameters.

Return null if wait period expired or was cancelled; otherwise, returns the event name.