Buffer.Read(Int32,Type,LockFlag,Int32[]) Method (Microsoft.DirectX.DirectSound)
Reads the current data in the buffer.
Definition
Visual Basic Public Function Read( _
ByVal bufferStartingLocation As Integer, _
ByVal returnedDataType As Type, _
ByVal flag As LockFlag, _
ByVal ranks() As Integer _
) As ArrayC# public Array
int bufferStartingLocation,
Type
LockFlag flag,
int[] ranks
);C++ public:
Array
int bufferStartingLocation,
Type
LockFlag flag,
array<int>^ ranks
);JScript public function Read(
bufferStartingLocation : int,
returnedDataType : Type
flag : LockFlag,
ranks : int[]
) : Array
Parameters
bufferStartingLocation System.Int32
An integer that represents the offet, in bytes, of where to begin reading from the buffer. This parameter is ignored if LockFlag.FromWriteCursor is specified in the flag parameter.returnedDataType System.Type
Value that indicates the Typeflag Microsoft.DirectX.DirectSound.LockFlag
A LockFlag enumerated value that describes the type of lock to perform.ranks System.Int32[]
Array of one to three Int32
Return Value
System.Array
An Array
Remarks
Exceptions
An invalid parameter was passed to the called method, or numberBytesToRead is set to zero.
One or more parameters is null.
The ranks parameter is out of range. The maximum number of dimensions for the ranks array is three.
The buffer memory has been lost and must be restored.
The method call is invalid. For example, a method's parameter might not be valid.
Unable to write to the receiving stream object, data. Check if the stream is writable.
A cooperative level of Priority or higher is required.
Applies To