IDirectSoundCaptureBuffer::GetFormat

  • Article

This method retrieves the current format of the capture buffer.

HRESULT GetFormat( 
  LPWAVEFORMATEX lpwfxFormat, 
  DWORD dwSizeAllocated, 
  LPDWORD lpdwSizeWritten 
);

Parameters

  • lpwfxFormat
    Address of the WAVEFORMATEX variable to contain a description of the sound data in the capture buffer. To retrieve the buffer size needed to contain the format description, specify NULL. In this case the DWORD pointed to by the lpdwSizeWritten parameter will receive the size of the structure needed to receive complete format information.
  • dwSizeAllocated
    Size, in bytes, of the WAVEFORMATEX structure. DirectSoundCapture writes, at most, dwSizeAllocated bytes to the structure; if the structure requires more memory, it is truncated.
  • lpdwSizeWritten
    Address of a variable to receive the number of bytes written to the WAVEFORMATEX structure. This parameter can be NULL.

Return Values

If the method succeeds, the return value is DS_OK.

If the method fails, the return value may be DSERR_INVALIDPARAM.

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Dsound.h.
Link Library: Dsound.lib.

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.