L_VecEmptyGroup

#include "ltvkrn.h"

L_LVKRN_API L_INT L_VecEmptyGroup(pVector, pGroup)

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

Parameters

pVECTORHANDLE pVector

Pointer to the vector handle.

const pVECTORGROUP pGroup

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

Returns

Value Meaning
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

See Also

Functions

Topics

Example

This example will delete all objects inside the group with the given name.

L_LTVKRNTEX_API L_INT VecEmptyGroupExample( 
   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_VecEmptyGroup ( pVector, &Group );  /* empty out */ 
 
   return nRet; 
} 

Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.