Microsoft DirectX 9.0 SDK Update (October 2004)

Volume.LockBox Method

Language:

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

Locks a box on a volume resource.

Definition

Visual Basic .NET Public Function LockBox( _
    ByVal typeLock As Type, _
    ByVal box As Box, _
    ByVal flags As LockFlags, _
    ByRef lockedVolume As LockedBox, _
    ByVal ranks() As Integer _
) As Array
C# public Array LockBox(
    Type typeLock,
    Box box,
    LockFlags flags,
    out LockedBox lockedVolume,
    int[] ranks
);
Managed C++ public: Array* LockBox(
    Type *typeLock,
    Box box,
    LockFlags flags,
    LockedBox *lockedVolume,
    int ranks __gc[]
);
JScript .NET public function LockBox(
    typeLock : Type,
    box : Box,
    flags : LockFlags,
    lockedVolume : LockedBox,
    ranks : int[]
) : Array;

Parameters

typeLock System.Type. Value that specifies the Type Leave Site of the lock.
box Microsoft.DirectX.Direct3D.Box. A Box object that represents the box to lock.
flags Microsoft.DirectX.Direct3D.LockFlags. Combination of zero or more LockFlags that describe the type of lock to perform. See Remarks.
lockedVolume Microsoft.DirectX.Direct3D.LockedBox. A LockedBox object that describes the locked region.
ranks System.Int32[]. Array of one to three Int32 Leave Site values that indicate the dimensions of the returned array. The maximum number of ranks allowed is three.

Return Value

System.Array . An Array Leave Site that represents the locked box region.

Remarks

The valid lock flags for this method are:

For performance reasons, dirty regions are recorded only for level zero of a texture. Dirty regions are automatically recorded when Volume.LockBox is called without LockFlags.NoDirtyUpdate or LockFlags.ReadOnly. For more information, see Device.UpdateTexture.

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


© 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