Microsoft DirectX 8.1 (C++)

IDirectMusicBuffer8::GetNextEvent

The GetNextEvent method returns information about the next message in the buffer and advances the read pointer.

Syntax

HRESULT GetNextEvent(
  LPREFERENCE_TIME prt, 
  LPDWORD pdwChannelGroup, 
  LPDWORD pdwLength, 
  LPBYTE* ppData
);

Parameters

prt

Address of a variable that receives the time of the message.

pdwChannelGroup

Address of a variable that receives the channel group of the message.

pdwLength

Address of a variable that receives the length, in bytes, of the message.

ppData

Address of a variable that receives a pointer to the message data.

Return Values

If the method succeeds, the return value is S_OK, or S_FALSE if there are no messages in the buffer.

If it fails, the method can return E_POINTER.

Remarks

Any of the passed pointers can be NULL if the item is not needed.

The pointer returned in ppData is valid only for the lifetime of the buffer object.

Requirements

  Header: Declared in dmusicc.h.

See Also