L_VecDeleteGroup
#include "lvkrn.h"
L_INT EXT_FUNCTION L_VecDeleteGroup(pVector, pGroup)
pVECTORHANDLE pVector; |
/* pointer to a vector handle */ |
const pVECTORGROUP pGroup; |
/* pointer to a vector group */ |
Deletes 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 to be deleted. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Deleting a group also deletes all objects within the group.
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: |
|
Topics: |
Example
/* This example will delete the group with the given name from the vector handle */
L_VOID DeleteGroupByName( 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_VecDeleteGroup ( pVector, &Group ); /* Delete it */
}