LVectorBase::Free

#include "ltwrappr.h"

virtual L_INT LVectorBase::Free(void)

Frees the memory allocated for the vector data.

Returns

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

Comments

Call this function to free the memory allocated for the vector data. This function should be called when your program no longer needs the vector data. If the vector was allocated in disk memory, this function deletes the temporary file. If the vector has a palette, it will be deleted. After this function returns, the internal vector handle will be invalidated.

Note: You do not have to call LVectorBase::Free unless you explicitly want to free the memory. The class object will automatically free the vector when it is destroyed.

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:	Class Members
Topics:	Vector Images: Modifying Vector Object Characteristics

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
L_INT LVectorBase__FreeExample(HWND hWnd)
{
   UNREFERENCED_PARAMETER(hWnd);
   L_INT          nRet;
   LVectorBase*   pVector = new(LVectorBase);
   nRet = pVector->Load(MAKE_IMAGE_PATH(TEXT("random.dxf")));
   if(nRet != SUCCESS)
      return nRet;
   //do some stuff
   //Free the vector
   nRet = pVector->Free();
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}