IDirectMusicChordMap::GetScale

The IDirectMusicChordMap::GetScale method retrieves the scale associated with the chordmap.

HRESULT GetScale(
  DWORD* pdwScale
);
 

Parameters

pdwScale

Address of a variable to receive the scale value.

Return Values

If the method succeeds, the return value is S_OK.

If the method fails, the return value may be E_POINTER.

Remarks

The scale is defined by the bits in a DWORD, split into a scale pattern (lower 24 bits) and a root (upper 8 bits). For the scale pattern, the low bit (0x0001) is the lowest note in the scale, the next higher (0x0002) is a semitone higher, and so on for two octaves. The upper 8 bits give the root of the scale as an integer between 0 and 23 (low C to middle B).

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dmusici.h.