Volume.LockBox Method

 Language:

Locks a box on a volume resource.

Definition

Visual Basic Public Function LockBox( _
    ByVal box As Box, _
    ByVal flags As LockFlags _
) As GraphicsStream
C# public GraphicsStream LockBox(
    Box box,
    LockFlags flags
);
C++ public:
GraphicsStream^ LockBox(
    Box box,
    LockFlags flags
);
JScript public function LockBox(
    box : Box,
    flags : LockFlags
) : GraphicsStream;

Parameters

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.

Return Value

Microsoft.DirectX.GraphicsStream
A GraphicsStream 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.

Send comments about this topic to Microsoft. © Microsoft Corporation. All rights reserved.

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