Microsoft DirectX 8.1 (C++)

IDirectMusicPerformance8::AssignPChannel

The AssignPChannel method assigns a single performance channel to the performance and maps it to a port, group, and MIDI channel.

This method is not used by applications that route their data through audiopaths.

Syntax

HRESULT AssignPChannel(
  DWORD dwPChannel, 
  IDirectMusicPort* pPort,
  DWORD dwGroup, 
  DWORD dwMChannel
);

Parameters

dwPChannel

Performance channel to assign.

pPort

Address of a variable that contains the port to which the channel is assigned.

dwGroup

Channel group on the port.

dwMChannel

Channel in the group. Must be in the range from 0 through 15.

Return Values

If the method succeeds, the return value is S_OK, or S_FALSE (see Remarks).

If it fails, the method can return one of the error values shown in the following table.

Return code
E_INVALIDARG
E_POINTER

Remarks

The method returns S_FALSE if dwGroup is out of the range of the port. The channel has been assigned, but the port cannot play this group.

The method returns E_INVALIDARG if dwMChannel is out of range or the port has not been added to the performance through a call to the IDirectMusicPerformance8::AddPort method.

Requirements

  Header: Declared in dmusici.h.

See Also