ULGetNotificationW method

Reads an event notification.

Syntax

public ul_bool ULGetNotificationW(
    SQLCA * sqlca,
    ul_wchar const * queue_name,
    ul_wchar * event_name_buf,
    ul_length event_name_buf_len,
    ul_u_long wait_ms
)

Parameters

sqlca A pointer to the SQLCA.
queue_name The queue to read or NULL for default connection queue.
event_name_buf A buffer to hold the name of the event.
event_name_buf_len The size of the buffer in ul_wchars.
wait_ms The time to wait (block) before returning.

Note

This method prototype is used internally when you refer to ULGetNotification and #define the UNICODE macro on Win32 platforms. Typically, you would not reference this method directly when creating an UltraLite application.

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

Discuss this page in DocCommentXchange.