L_VecDeleteLayer

#include "lvkrn.h"

L_LVKRN_API L_INT L_VecDeleteLayer(pVector, pLayer)

pVECTORHANDLE pVector;

/* pointer to a vector handle */

const pVECTORLAYER pLayer;

/* pointer to a vector layer */

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

Parameter

Description

pVector

Pointer to the vector handle.

pLayer

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

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Deleting a layer also deletes all objects within the layer.

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_VecAddLayer, L_VecEmptyLayer.

Topics:

Working with Vector Layers

Example

This example will delete the layer with the given name from the vector handle.

L_INT VecDeleteLayerExample(
   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_VecDeleteLayer ( pVector, &Layer );  /* Delete it */

   return nRet;
}