LVectorBase::IsLocked

#include "ltwrappr.h"

virtual L_INT LVectorBase::IsLocked(pbLocked)

Determines whether or not the class object's associated vector is locked.

Parameters

L_BOOL * pbLocked

Pointer to a variable to be updated with a value that indicates whether the class object's associated vector is locked. Possible values are:

Value Meaning
TRUE The class object's associated vector is locked.
FALSE The class object's associated vector is not locked.

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.

Required DLLs and Libraries

See Also

Functions

Topics

Example

This example toggles the locked state of the vector.

L_INT LVectorBase__IsLockedExample(HWND hWnd, LVectorBase *pVector) 
 
{ 
   UNREFERENCED_PARAMETER(hWnd); 
 
   UNREFERENCED_PARAMETER(pVector); 
 
   L_INT    nRet; 
   L_BOOL   bLocked; 
 
   nRet = pVector->IsLocked(&bLocked); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = pVector-> SetLocked(!bLocked); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   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++ Class Library Help