SpConvertStreamFormatEnum
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This function converts the specified stream format into a fully populated wave format structure.
Syntax
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 Value
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
| Header | sphelper.h |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |