IDirectMusicPerformance8::SetNotificationHandle

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicPerformance8::SetNotificationHandle

The SetNotificationHandle method sets the event handle for notifications.

Syntax

HRESULT SetNotificationHandle(
  HANDLE hNotification,
  REFERENCE_TIME rtMinimum
);

Parameters

hNotification

Event handle created by CreateEvent, or 0 to clear out an existing handle.

rtMinimum

Minimum time that the performance should hold onto old notify events before discarding them. The value 0 means to use the default minimum time of 20,000,000 reference time units, which is 2 seconds, or the previous value if this method has been called previously. If the application has not called GetNotificationPMsg by this time, the event is discarded to free the memory.

Return Values

The method returns S_OK.

Remarks

When the event is signaled, the application should call the IDirectMusicPerformance8::GetNotificationPMsg method to retrieve the notification event.

It is the application's responsibility to call the Win32 CloseHandle function on the notification handle when it is no longer needed.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.