Platform SDK: DirectX

DirectSoundBuffer.ReadBuffer

The DirectSoundBuffer.ReadBuffer method reads a segment of the sound buffer and stores the data in an application buffer.

object.ReadBuffer(start As Long, _
    size As Long, _
    buffer As Any, _
    flags As CONST_DSBLOCKFLAGS)

object: Object expression that resolves to a DirectSoundBuffer object.
start: Offset, in bytes, from the start of the buffer to where the read begins. This parameter is ignored if DSBLOCK_FROMWRITECURSOR is specified in the flags parameter.
size: Size, in bytes, of the portion of the buffer to read. The sound buffer is conceptually circular, so this value can be greater than the number of bytes between start and the end of the buffer. This member is ignored if DSBLOCK_ENTIREBUFFER is specified in the flags parameter.
buffer: Variable to hold the data read. Typically this is an array of bytes, and you pass the first element of the array.
flags: One of the constants of the CONST_DSBLOCKFLAGS enumeration.

If the method fails, an error is raised and Err.Number may be set to one of the following error codes.