LVectorBase::SetHandle

Summary

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

Syntax

#include "ltwrappr.h"

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

Parameters

pVECTORHANDLE 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.

L_BOOL 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

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

See Also

Functions

Topics

Example

For an example, refer to LVectorBase::GetHandle.

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

LEADTOOLS Vector C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.