IDirectMusicPerformance8::RemoveNotificationType

^{IDirectMusicPerformance8::RemoveNotificationType}

The RemoveNotificationType method removes a previously added notification type from the performance. All segments and tracks are updated by a call to their RemoveNotificationType methods.

Syntax

HRESULT RemoveNotificationType(
  REFGUID rguidNotificationType
);

Parameters

rguidNotificationType

Reference to (C++) or address of (C) the identifier of the notification type to remove. (For the defined types, see DMUS_NOTIFICATION_PMSG.) If this value is GUID_NULL, all notifications are removed.

Return Values

If the method succeeds, the return value is S_OK or S_FALSE (see Remarks).

If it fails, the method can return E_POINTER.

Remarks

S_FALSE is returned when rguidNotificationType is not an active notification.

If a notification was added to a segment that has stopped playing, the performance cannot remove the notification type from that segment because it no longer has a reference to the segment.

Requirements

  Header: Declared in dmusici.h.

See Also

• IDirectMusicPerformance8 Interface
• IDirectMusicPerformance8::AddNotificationType
• IDirectMusicSegment8::RemoveNotificationType
• IDirectMusicTrack8::RemoveNotificationType
• Notification and Event Handling