![]() |
![]() |
![]() |
Volume.LockBox Method |
Language: |
Locks a box on a volume resource.
Visual Basic .NET Public Function LockBox( _
ByVal typeLock As Type, _
ByVal flags As LockFlags, _
ByRef lockedVolume As LockedBox, _
ByVal ranks() As Integer _
) As ArrayC# public Array LockBox(
Type typeLock,
LockFlags flags,
out LockedBox lockedVolume,
int[] ranks
);Managed C++ public: Array* LockBox(
Type *typeLock,
LockFlags flags,
LockedBox *lockedVolume,
int ranks __gc[]
);JScript .NET public function LockBox(
typeLock : Type,
flags : LockFlags,
lockedVolume : LockedBox,
ranks : int[]
) : Array;
typeLock System.Type. Value that specifies the Type of the 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 values that indicate the dimensions of the returned array. The maximum number of ranks allowed is three.
System.Array . An Array
that represents the locked box region.
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.
Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center