LVectorBase::SetLocked

#include "ltwrappr.h"

virtual L_INT LVectorBase::SetLocked(bLock)

L_BOOL bLock;

/* flag */

Locks or unlocks the class object's associated vector.

This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

Parameter

Description

bLock

Flag that indicates whether to lock or unlock the class object's associated vector. Possible values are:

 

Value

Meaning

 

TRUE

Lock the class object's associated vector.

 

FALSE

Unlock the class object's associated vector.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Locking a vector handle has precedence over locking layers within the vector handle. Therefore, if a vector handle is locked, the layers within that vector handle cannot be edited, even if the layers are not locked.

OpenGL and DirectX engines lock the vector handle automatically.

To lock a layer, set the bLocked member of a VECTORLAYERDESC structure to TRUE and update the layer information using the LVectorLayer::SetLayerDesc function.

Required DLLs and Libraries

LVKRN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LVectorBase::IsLocked

Topics:

Working with Vector Handles

Example

For an example, refer to LVectorBase::IsLocked.