In This Topic ▼

L_VecEmptyLayer

Summary

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

Syntax

#include "ltvkrn.h"

L_LVKRN_API L_INT L_VecEmptyLayer(pVector, pLayer)

Parameters

pVECTORHANDLE pVector

Pointer to the vector handle.

const pVECTORLAYER pLayer

Pointer to a VECTORLAYER structure that references the layer to be emptied.

Returns

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

Comments

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

To delete a layer, call L_VecDeleteLayer.

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.

Example

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

L_INT VecEmptyLayerExample( 
   pVECTORHANDLE pVector, 
   L_TCHAR* pszName) 
{ 
   VECTORLAYER Layer; 
   L_INT       nRet; 
 
   /* Get the layer with the given name */ 
   nRet = L_VecGetLayerByName( pVector, pszName, &Layer ); 
   if( SUCCESS == nRet ) 
      nRet = L_VecEmptyLayer( pVector, &Layer );  /* empty out */ 
 
   return nRet; 
}