LVectorLayer::EmptyLayer

#include "ltwrappr.h"

virtual L_INT LVectorLayer::EmptyLayer(L_VOID)

Empties the class object's associated layer. This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

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

To delete a layer, call LVectorLayer::DeleteLayer

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:

LVectorBase::AddLayer, LVectorLayer::DeleteLayer, LVectorBase::CopyLayer, LVectorLayer::AddObject, LVectorBase::CopyObject, LVectorBase::GetLayerByIndex, LVectorBase::GetLayerByName

Topics:

Working with Vector Layers

Example

This example will empty all objects from the second layer (index 1).

L_INT LVectorLayer__EmptyLayerExample(HWND hWnd, LVectorBase *pVector)
{
   UNREFERENCED_PARAMETER(hWnd);
   L_INT          nRet;
   LVectorLayer   VectorLayer;
   nRet = pVector->GetLayerByIndex(1, &VectorLayer);
   if (nRet == SUCCESS)
   {
      nRet = VectorLayer.EmptyLayer();
      if(nRet != SUCCESS)
         return nRet;
   }
   else
   {
      MessageBox(hWnd, TEXT("Vector has less than two layers"), TEXT(""), MB_OK);
      return nRet;
   }
   return SUCCESS;
}