Microsoft DirectX 8.1 (C++)

IDirectMusicPerformance8::GetNotificationPMsg

The GetNotificationPMsg method retrieves a pending notification message.

Syntax

HRESULT GetNotificationPMsg(
  DMUS_NOTIFICATION_PMSG**  ppNotificationPMsg
);

Parameters

ppNotificationPMsg

Address of a variable that receives a pointer to a DMUS_NOTIFICATION_PMSG structure. The application retrieving this message is responsible for calling IDirectMusicPerformance8::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 most notifications, the segment state that generated the notification can be retrieved from the punkUser member of the message structure, and the segment can be retrieved by using IDirectMusicSegmentState8::GetSegment.

Requirements

  Header: Declared in dmusici.h.

See Also