Microsoft DirectX 9.0 SDK Update (October 2004)

CaptureBuffer.Read Method

Language:

Note: This documentation is preliminary and is subject to change.

Reads current data in the capture buffer.

Definition

Visual Basic .NET Public Sub Read( _
    ByVal bufferStartingLocation As Integer, _
    ByVal data As Stream, _
    ByVal numberBytesToRead As Integer, _
    ByVal flag As LockFlag _
)
C# public void Read(
    int bufferStartingLocation,
    Stream data,
    int numberBytesToRead,
    LockFlag flag
);
Managed C++ public: void Read(
    int bufferStartingLocation,
    Stream *data,
    int numberBytesToRead,
    LockFlag flag
);
JScript .NET public function Read(
    bufferStartingLocation : int,
    data : Stream,
    numberBytesToRead : int,
    flag : LockFlag
);

Parameters

bufferStartingLocation System.Int32. An integer that represents the offet, in bytes, of where to begin reading from the capture buffer. This parameter is ignored if LockFlag.FromWriteCursor is specified in the flag parameter.
data System.IO.Stream. A Stream Leave Site object that receives the data read from the capture buffer.
numberBytesToRead System.Int32. An integer that represents the number of bytes read into data from the buffer. The buffer is conceptually circular, so this number can exceed the number of bytes between bufferStartingLocation and the end of the buffer.
flag Microsoft.DirectX.DirectSound.LockFlag. A LockFlag enumerated value that describes the type of lock to perform.

Remarks

Exceptions
ArgumentException Leave Site An invalid parameter was passed to the called method, or numberBytesToRead is set to zero.
ArgumentNullException Leave Site One or more parameters is null.
ArgumentOutOfRangeException Leave Site The ranks parameter is out of range. The maximum number of dimensions for the ranks array is three.
BufferLostException The buffer memory has been lost and must be restored.
InvalidCallException The method call is invalid. For example, a method's parameter might not be valid.
NotSupportedException Leave Site Unable to write to the receiving stream object, data. Check if the stream is writable.
PriorityLevelNeededException A cooperative level of Priority or higher is required.


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center