LVectorBase::GetGroupByName

#include "ltwrappr.h"

virtual L_INT LVectorBase::GetGroupByName(pszName, pVectorGroup)

Gets the group 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 group to get.

LVectorGroup *pVectorGroup

Pointer to an LVectorGroup object to be updated with the group handle, if the group is found. If the group is not found, this function will return ERROR_VECTOR_GROUP_NOT_FOUND.

Returns

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

Comments

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

Required DLLs and Libraries

See Also

Functions

Topics

Example

This example will delete all clones of the named group from pVector.

L_INT LVectorBase__GetGroupByNameExample(HWND hWnd, LVectorBase *pVector) 
{ 
   UNREFERENCED_PARAMETER(hWnd); 
 
   LVectorGroup   VectorGroup; 
   L_INT          nRet; 
   L_TCHAR*       pszName = TEXT("TerryGroup1"); 
 
   // Get the group with the given name  
   nRet = pVector->GetGroupByName(pszName, &VectorGroup ); 
   if( nRet == SUCCESS ) 
   { 
      // Delete its clones 
      nRet = VectorGroup.DeleteGroupClones(); 
      if(nRet != SUCCESS) 
         return nRet; 
   } 
   else 
      return nRet; 
 
   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