IDirectMusicPerformance::GetNotificationPMsg

The IDirectMusicPerformance::GetNotificationPMsg method retrieves a pending notification message.

HRESULT GetNotificationPMsg(
  DMUS_NOTIFICATION_PMSG** ppNotificationPMsg
);

Parameters

ppNotificationPMsg

Address of a variable to receive a pointer to a DMUS_NOTIFICATION_PMSG structure. The application retrieving this message is responsible for calling IDirectMusicPerformance::FreePMsg on it.

Return Values

If the method succeeds, the return value is S_OK or, S_FALSE if there are no more notification events to return.

If it fails, the method can return E_POINTER.

Remarks

For an example, see Handle Notifications in the tutorial on using compositions.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.

See Also

Notification and Event Handling