LVectorBase::SetHandle

#include "ltwrappr.h"

L_INT LVectorBase::SetHandle(pVectorHandle, bFreePrev=TRUE)

pVECTORHANDLE pVectorHandle;

/* pointer to a LEAD vector handle */

L_BOOL bFreePrev;

/* flag that indicates whether to free the previous bitmap */

Attaches a new LEAD vector handle to the LVectorBase class object.

Parameter

Description

pVectorHandle

Pointer to a LEAD vector handle that describes the vector to be attached to this object. This pointer will be invalidated if the function is successful, you can pass NULL if you only want to detach the current vector handle from the object.

bFreePrev

Flag that indicates whether to free the previous vector handle before attaching the new one. Possible values are:

 

Value

Meaning

 

TRUE

Free the previous vector handle before attaching the new one.

 

FALSE

Do not free the previous vector handle before attaching the new one.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Use this function to attach a new LEAD vector handle to this LVectorBase class object. This function will call the LVectorBase::StartChanging and LVectorBase::EndChanging member functions before and after setting the vector handle.

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::GetHandle, LVectorBase::StartChanging, LVectorBase::EndChanging, Class Members

Topics:

Vector Images: Getting and Setting General Information

Example

For an example, refer to LVectorBase::GetHandle.