L_VecEmptyGroup

#include "lvkrn.h"

L_INT EXT_FUNCTION L_VecEmptyGroup(pVector, pGroup)

pVECTORHANDLE pVector;	/* pointer to a vector handle */
const pVECTORGROUP pGroup;	/* pointer to a vector group */

Empties the specified group. This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

Parameter	Description
pVector	Pointer to the vector handle.
pGroup	Pointer to a VECTORGROUP structure that references the group to be emptied.

Returns

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

Comments

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

To delete a group, call L_VecDeleteGroup.

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:	L_VecAddGroup, L_VecDeleteGroup, L_VecCopyGroup, L_VecDeleteGroupClones, L_VecAddObjectToGroup, L_VecGetGroup, L_VecGetGroupByIndex, L_VecGetGroupByName
Topics:	Working with Vector Groups

Example

/* This example will delete all objects inside the group with the given name */
L_VOID EmptyGroupByName( pVECTORHANDLE pVector, L_TCHAR *pszName )
{
   VECTORGROUP Group;
   L_INT       nRet;

   /* Get the group with the given name */
   nRet = L_VecGetGroupByName( pVector, pszName, &Group );
   if( SUCCESS == nRet )
      L_VecEmptyGroup ( pVector, &Group );  /* empty out */
}