L_VecDeleteGroupClones

#include "lvkrn.h"

L_LVKRN_API L_INT L_VecDeleteGroupClones(pVector, pGroup, dwFlags)

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

Deletes all clones of the specified group from the vector handle. 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 of which its clones to be deleted.
dwFlags	Can be a combination of the following:
	Value	Meaning
	0	Delete all clones.
	VECTOR_FLAGS_SELECTED_ONLY	Delete only the currently selected clones within the vector handle.

Returns

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

Comments

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_VecEmptyGroup.
Topics:	Working with Vector Groups

Example

This example will delete all clones of the group with the given name from the vector handle.

L_INT VecDeleteGroupClonesExample(
   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 )
      nRet = L_VecDeleteGroupClones ( pVector, &Group, 0L );  /* Delete its clones */

   return nRet;
}