IDirectMusicSegment8::InitPlay

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicSegment8::InitPlay

The InitPlay method initializes the play state. This method was for internal use and is not implemented in versions later than DirectX 7.0.

Syntax

HRESULT InitPlay(
  IDirectMusicSegmentState** ppSegState, 
  IDirectMusicPerformance* pPerformance,
  DWORD dwFlags
);

Parameters

ppSegState

Address of a variable that receives a pointer to the IDirectMusicSegmentState8 interface that is created in response to this method call and is used to hold state data. It is returned with a reference count of 1, so a call to its Release method fully releases it.

pPerformance

Address of the IDirectMusicPerformance8 interface. This is needed by the segment and segment state to call methods on the performance object.

dwFlags

DMUS_SEGF_FLAGS that modify the track's behavior.

Return Values

In DirectX 8.0 and later, the method returns E_NOTIMPL.

In earlier versions, if the method succeeds, the return value is S_OK. If it fails, it can return one of the error values shown in the following table.

Return code
E_POINTER
E_OUTOFMEMORY

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.