Collapse All Expand All

LVectorPolyline::UnlockObject

#include "ltwrappr.h"

virtual L_INT LVectorPolyline::UnlockObject(pPolyLine)

pVECTORPOLYLINE pPolyLine;

/* pointer to a vector object */

Sets the object information of the class object. This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

Parameter	Description
pPolyLine	Pointer to a VECTORPOLYLINE structure that contains the vector object information to set.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function is used to update the object information of the class object.

To use this method, declare a variable of type VECTORPOLYLINE and pass the address to the LVectorPolyline::LockObject () function. After modifying the vector object settings, call LVectorPolyline::UnlockObject(). LVectorPolyline::LockObject () and LVectorPolyline::UnlockObject() should always be called in pairs.

Before an object has been added to the LVectorBase object, using LVectorBase::AddObject or LVectorLayer::AddObject, LVectorPolyline::UnlockObject () can be used to change ALL properties of an object. However, once the object has been added to the LVectorBase object, some properties cannot be changed using LVectorPolyline::UnlockObject(). Specifically, nPointCount, *Point, pszText, and pbyType cannot be changed. However, as long as the number of points does not change, the coordinates of the individual points can always be modified using LVectorPolyline::UnlockObject().

To get the current object information for a class object, call LVectorPolyline::LockObject.

LVectorPolyline::LockObject and LVectorPolyline::UnlockObject must be called in pairs.

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:	LVectorPolyline::LockObject
Topics:	Working with Vector Objects

Example

For an example, refer to LVectorObject::UnlockObject.