WaitForNtmsNotification

[This is preliminary documentation and subject to change.]

The WaitForNtmsNotification function waits for the next object change notification.

DWORD WINAPI WaitForNtmsNotification(
  HANDLE hSession,
  HANDLE hNotification,
  LPNTMS_NOTIFICATIONINFORMATION lpNotificationInformation,
  DWORD dwTimeout
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

hNotification

Notification handle generated by the OpenNtmsNotification function.

lpNotificationInformation

Specifies notification information. For more information, see the NTMS_NOTIFICATIONINFORMATION data structure.

dwTimeout

Specifies the maximum number of milliseconds to wait. If you specify a value of INFINITE, this function will not time-out.

Return Values

ERROR_DATABASE_FAILURE

The database query or update failed.

ERROR_INVALID_HANDLE

The value specified in the hNotification parameter is invalid or NULL.

ERROR_NO_DATA

Notification pipe failed. Attempt to set up notification again.

ERROR_NOT_CONNECTED

Unable to connect to the RSM.

ERROR_TIMEOUT

The time-out event expired.

ERROR_SUCCESS

The function was successful.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.

See Also

Database Notification Functions, CloseNtmsNotification, OpenNtmsNotification