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 Function Read( _
    ByVal bufferStartingLocation As Integer, _
    ByVal returnedDataType As Type, _
    ByVal flag As LockFlag, _
    ByVal ranks() As Integer _
) As Array
C# public Array Read(
    int bufferStartingLocation,
    Type returnedDataType,
    LockFlag flag,
    int[] ranks
);
Managed C++ public: Array* Read(
    int bufferStartingLocation,
    Type *returnedDataType,
    LockFlag flag,
    int ranks __gc[]
);
JScript .NET 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 capture buffer. This parameter is ignored if LockFlag.FromWriteCursor is specified in the flag parameter.
returnedDataType System.Type. Value that indicates the Type Leave Site of the returned array.
flag 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 Leave Site values that indicate the dimensions of the returning Array. The maximum number of ranks allowed is three.

Return Value

System.Array . An Array Leave Site of type returnedDataType that contains the data read from the buffer.

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