CopyTo (Microsoft Speech Platform)

Microsoft Speech Platform

CSpStreamFormat::CopyTo

CSpStreamFormat::CopyTo copies the instance's wave format to a new stream.

HRESULT CopyTo(
   GUID            *pFormatId,
   WAVEFORMATEX   **ppCoMemWFEX
   );

pFormatId: The new format ID based on the class member m_guidFormatId's ID. If class member m_pCoMemWaveFormatEx is invalid, pFormatId is set to NULL.
ppCoMemWFEX: The new wave format. If ppCoMemWFEX could not be successfully created, pFormatId is set to zero.

This method copies the instance's stream to an existing stream.

HRESULT CopyTo(
   wCSpStreamFormat &Other
);

Other: The existing stream to copy to. The stream is freed using CoTaskMemFree() first and the instance is then copied to it.

The return values are the same for both methods.

Value	Description
S_OK	Function completed successfully.
E_OUTOFMEMORY	Exceeded available memory.