IMiniportMidiStream::SetFormat method (portcls.h)

The SetFormat method sets the KS data format of the MIDI stream.

Syntax

NTSTATUS SetFormat(
  [in] PKSDATAFORMAT DataFormat
);

Parameters

[in] DataFormat

Specifies the new format for the stream. This parameter is a pointer to a structure of type KSDATAFORMAT.

Return value

SetFormat returns STATUS_SUCCESS if the call was successful. Otherwise, the method returns an appropriate error code.

Remarks

The SetFormat method essentially does nothing because the data format of a MIDI stream cannot be changed to anything other than MIDI. This method is provided for the sake of completeness and for orthogonality with the SetFormat methods in the IMiniportWaveCyclic and IMiniportWavePci interfaces. See the trivial implementation of this method in the fmsynth sample audio driver in the Microsoft Windows Driver Kit (WDK). You can use the sample code as a template for your own implementation.

Requirements

Requirement Value
Target Platform Universal
Header portcls.h (include Portcls.h)
IRQL PASSIVE_LEVEL

See also

IMiniportMidiStream

KSDATAFORMAT