SpConvertStreamFormatEnum

  • Article

This function converts the specified stream format into a fully populated wave format structure.

inline HRESULT SpConvertStreamFormatEnum(
  SPSTREAMFORMAT eFormat,
  GUID* pFormatId,
  WAVEFORMATEX** ppCoMemWaveFormatEx
);

Parameters

  • eFormat
    [in] Requested stream format, as defined by the SPSTREAMFORMAT enumeration. The supplied value must have a value of SPSF_8kHz8BitMono or higher.
  • pFormatId
    [in, out] Pointer to the format identifier. This value can be GUID_NULL if an error occurred.
  • ppCoMemWaveFormatEx
    [out] Address of a pointer to a populated WAVEFORMATEX structure.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
E_OUTOFMEMORY Exceeded available memory.
E_INVALIDARG Either pFormatId or ppCoMemWaveFormatEx is invalid or bad. Alternatively, the specified format is not recognized.
FAILED(hr) Appropriate error message.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sphelper.h.
Link Library: Sapilib.lib.

See Also

SAPI Functions

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.