LVectorBase::GetGroupByName

Summary

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

Syntax

virtual L_INT LVectorBase::GetGroupByName(pszName, pVectorGroup)

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

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

• 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.

See Also

Functions

• LVectorBase::GetGroupCount
• LVectorBase::GetGroupByIndex
• LVectorGroup::GetGroupDesc

Topics

• Working with Vector Groups

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; 
}