PatchMesh.LockIndexBuffer(Type,LockFlags,Int32[]) Method (Microsoft.DirectX.Direct3D)

Locks the index buffer.

Definition

Visual Basic Public Function LockIndexBuffer( _
    ByVal typeIndex As TypeLeave Site, _
    ByVal flags As LockFlags, _
    ByVal ranks() As Integer _
) As ArrayLeave Site
C# public ArrayLeave Site LockIndexBuffer(
    TypeLeave Site typeIndex,
    LockFlags flags,
    int[] ranks
);
C++ public:
ArrayLeave SiteLockIndexBuffer(
    TypeLeave SitetypeIndex,
    LockFlags flags,
    array<int>^ ranks
);
JScript public function LockIndexBuffer(
    typeIndex : TypeLeave Site,
    flags : LockFlags,
    ranks : int[]
) : ArrayLeave Site;

Parameters

typeIndex System.Type
A TypeLeave Site object that indicates the type of array data to return. This can be a value type or any type that contains only value types.
flags Microsoft.DirectX.Direct3D.LockFlags
Zero or more LockFlags that describe the type of lock to perform. For this method, the valid flags are Discard, NoDirtyUpdate, NoSysLock, and ReadOnly. For a description of the flags, see LockFlags.
ranks System.Int32[]
Array of one to three Int32Leave Site values that indicate the dimensions of the returning ArrayLeave Site.

Return Value

System.Array
An ArrayLeave Site that represents the locked index buffer.

Remarks

The index buffer is usually locked, written to, and then unlocked for reading. Patch mesh index buffers are 16-bit buffers.

Exceptions

InvalidCallException

The method call is invalid. For example, a method's parameter might contain an invalid value.

OutOfMemoryExceptionLeave Site

Microsoft Direct3D could not allocate sufficient memory to complete the call.

See Also