IMiniportWavePciStream::SetFormat method (portcls.h)

Article
02/22/2024

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

Syntax

NTSTATUS SetFormat(
  [in] PKSDATAFORMAT DataFormat
);

Parameters

[in] DataFormat

Pointer to KSDATAFORMAT structure that describes the new format of the stream.

Return value

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

Remarks

The wave stream's initial format is specified in the IMiniportWavePci::NewStream call that creates the stream. Following stream creation, the SetFormat call can change the stream's format from its initial setting.

For information about specifying wave stream formats, see Audio Data Formats and Data Ranges.

Requirements

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