L_VecDeleteGroup

Summary

Deletes the specified group from the vector handle. This function is available in the LEADTOOLS Vector Imaging Toolkit.

Syntax

L_LVKRN_API L_INT L_VecDeleteGroup(pVector, pGroup)

Parameters

pVECTORHANDLE pVector

Pointer to the vector handle.

const pVECTORGROUP pGroup

Pointer to a VECTORGROUP structure that references the group to be deleted.

Returns

Comments

Deleting a group also deletes all objects within the group.

Required DLLs and Libraries

• LTVKRN
• 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 the group with the given name from the vector handle.

L_INT VecDeleteGroupExample( 
   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_VecDeleteGroup ( pVector, &Group );  /* Delete it */ 
 
   return nRet; 
}