LVectorBase::GetLayerByName

#include "ltwrappr.h"

virtual L_INT LVectorBase::GetLayerByName(pszName, pVectorLayer)

Gets the layer with the specified name, in the class object's associated vector handle.

Parameters

const L_TCHAR *pszName

Character string that contains the name of the layer to get.

LVectorLayer * pVectorLayer

Pointer to an LVectorLayer object structure to be updated with the layer handle, if the layer is found. If the layer is not found, this function will return ERROR_VECTOR_LAYER_NOT_FOUND.

Returns

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

Comments

If two or more layers in a vector handle have the same name, this function will get the first layer found.

Required DLLs and Libraries

See Also

Functions

Topics

Example

This example will get a layer by name.

L_INT LVectorBase__GetLayerByNameExample(HWND hWnd, LVectorBase *pVector) 
{ 
   UNREFERENCED_PARAMETER(hWnd); 
 
   L_INT          nRet; 
   LVectorLayer   VectorLayer; 
   L_TCHAR        szMsg[100]; 
 
   //Get the layer called "Sphere3" 
   nRet = pVector->GetLayerByName(TEXT("Sphere3"), &VectorLayer); 
   if (nRet == SUCCESS) 
   { 
      VECTORLAYERDESC LayerDesc; 
      nRet = VectorLayer.GetLayerDesc(&LayerDesc); 
      if(nRet != SUCCESS) 
         return nRet; 
      wsprintf(szMsg, TEXT("Layer Retrieved\nName[%s]\nSize[%d]\nLocked[%d]\nVisible[%d]"), 
         LayerDesc.szName, 
         LayerDesc.nSize, 
         LayerDesc.bLocked, 
         LayerDesc.bVisible 
         ); 
   } 
   else 
   { 
      wsprintf(szMsg, TEXT("Layer Not Found")); 
 
      return nRet; 
   } 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   return SUCCESS; 
} 

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

LEADTOOLS Vector C++ Class Library Help