LVectorGroup::EmptyGroup

#include "ltwrappr.h"

virtual L_INT LVectorGroup::EmptyGroup()

Empties the class object's associated group. This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

Returns

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

Comments

The associated group is emptied by deleting all objects within that group.

To delete a group, call LVectorGroup::DeleteGroup.

After calling this function, all clone objects of this group will reflect the change immediately.

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::AddGroup, LVectorGroup::DeleteGroup, LVectorBase::CopyGroup, LVectorGroup::DeleteGroupClones, LVectorBase::GetGroupByIndex, LVectorBase::GetGroupByName
Topics:	Working with Vector Groups

Example

This example will empty all objects from the second group (index 1).

L_INT LVectorGroup__EmptyGroupExample(HWND hWnd, LVectorBase *pVector)
{
   L_INT          nRet;
   LVectorGroup   VectorGroup;
   nRet = pVector->GetGroupByIndex(1, &VectorGroup);
   if (nRet == SUCCESS)
   {
      nRet = VectorGroup.EmptyGroup();
      if(nRet != SUCCESS)
         return nRet;
   }
   else
   {
      MessageBox(hWnd, TEXT("Vector has less than two groups"), TEXT(""), MB_OK);
      return nRet;
   }
   return SUCCESS;
}