IDirectMusicStyle8::GetEmbellishmentLength

The GetEmbellishmentLength method finds the shortest and longest lengths for patterns of the specified embellishment type and groove level.

Syntax

HRESULT GetEmbellishmentLength(
  DWORD dwType, 
  DWORD dwLevel, 
  DWORD* pdwMin, 
  DWORD* pdwMax
);

Parameters

dwType

Embellishment type. This can be one of the DMUS_COMMANDT_TYPES enumeration, or a value defined in DirectMusic Producer as a custom embellishment.

dwLevel

Groove level, in the range from 1 through 100. Ignored if dwType is not DMUS_COMMANDT_GROOVE.

pdwMin

Address of a variable that receives the length, in measures, of the shortest pattern of the specified type and groove level.

pdwMax

Address of a variable that receives the length, in measures, of the longest pattern of the specified type and groove level.

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

If there are no patterns of the specified type and groove level, the method returns S_FALSE.

Requirements

  Header: Declared in dmusici.h.

See Also

• IDirectMusicStyle8 Interface