LVectorWindow::Free

#include "ltwrappr.h"

virtual L_INT LVectorWindow::Free(L_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.

Call this function to remove a vector from an LVectorWindow object. Doing this will cause the LVectorWindow object to be painted with the LVectorWindow background color.

Note: You do not have to call the Free function before destroying an LVectorWindow object. The class object will automatically free the vector when it is destroyed.

Note: This function is available from the parent class (LVectorBase), and is not explicitly defined in the LVectorWindow class.

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

Example

Assumes pVectorWindow points to a valid LVectorWindow object.

L_INT LVectorWindow__FreeExample(LVectorWindow *pVectorWindow)
{
   L_INT nRet;
   //Changes the background color of the vector to yellow
   nRet = pVectorWindow->SetBackgroundColor( RGB(255,255,0) );
   if(nRet != SUCCESS)
      return nRet;
   //Erases the vector from the LVectorWindow object, leaving a yellow background
   nRet = pVectorWindow->Free();
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}