LVectorBase::IsLocked

#include "ltwrappr.h"

virtual L_INT LVectorBase::IsLocked(pbLocked)

/* pointer to a variable to be updated */

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

Parameter	Description
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

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.

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::SetLocked
Topics:	Working with Vector Handles

Example

//This example toggles the locked state of the vector.
L_VOID Example62(HWND hWnd, LVectorBase *pVector)
{
   L_BOOL bLocked;

   pVector->IsLocked(&bLocked);
   pVector-> SetLocked(!bLocked);
}