L_VecSetLocked

#include "ltvkrn.h"

L_LTVKRN_API L_INT L_VecSetLocked(pVector, bLock)

Locks or unlocks the specified vector handle. This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

Parameters

pVECTORHANDLE pVector

Pointer to a vector handle.

L_BOOL bLock

Flag that indicates whether to lock or unlock the specified vector handle. Possible values are:

Value Meaning
TRUE Lock the specified vector handle.
FALSE Unlock the specified vector handle.

Returns

Value Meaning
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.

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

Required DLLs and Libraries

See Also

Functions

Topics

Example

This example will toggle the lock property of a vector handle.

L_LTVKRNTEX_API L_INT VecSetLockedExample(pVECTORHANDLE pVector) 
{ 
   if( L_VecIsLocked( pVector ) ) 
      L_VecSetLocked( pVector, FALSE ); 
   else 
      L_VecSetLocked( pVector, TRUE ); 
 
   return SUCCESS; 
} 

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C API Help