IDirectMusicStyle8::GetMotif

DirectMusic

Microsoft DirectX 9.0 SDK Update (Summer 2004)

IDirectMusicStyle8::GetMotif

The GetMotif method creates a segment containing a motif specified by name.

Syntax

HRESULT GetMotif(
  WCHAR* pwszName, 
  IDirectMusicSegment** ppSegment
);

Parameters

pwszName

Name of the motif.

ppSegment

Address of a variable that receives a pointer to a segment containing the named motif.

Return Values

If the method succeeds, the return value is S_OK or S_FALSE.

If it fails, the method can return E_POINTER.

Remarks

The method searches the style's list of motifs for one whose name matches pwszName. If one is found, a segment is created containing a motif track. The track references the style as its associated style and the motif as its pattern.

If there is no motif with the name, the method returns S_FALSE.

Requirements

  Header: Declared in dmusici.h.

See Also


© 2004 Microsoft Corporation. All rights reserved.