L_VecGetGroupCount

#include "lvkrn.h"

L_LVKRN_API L_INT L_VecGetGroupCount(pVector)

const pVECTORHANDLE pVector;

pointer to a vector handle

Returns the number of groups inside a vector handle.

Parameter

Description

pVector

Pointer to the vector handle.

Returns

Number of groups.

Comments

After calling this function, L_VecGetGroupByIndex can be used to iterate through the groups in a vector handle.

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_VecGetGroupByName, L_VecGetGroupByIndex, L_VecGetGroup

Topics:

Working with Vector Groups

Example

This example will show the names of the all groups inside a vector handle, in a message box.

L_INT VecGetGroupCountExample(pVECTORHANDLE pVector) 
{ 
   L_INT nRet; 
   L_INT nCount, i; 
   VECTORGROUP Group; 
   VECTORGROUPDESC GroupDesc; 
   /* Get number of groups inside the vector handle */ 
   nCount = L_VecGetGroupCount( pVector ); 
   nRet = SUCCESS; 
   /* Iterate through the groups */ 
   for( i = 0; i < nCount; i++ ) 
   { 
      /* Get group and its descriptor */ 
      nRet = L_VecGetGroupByIndex( pVector, i, &Group ); 
      if(nRet != SUCCESS) 
         return nRet; 
      nRet = L_VecGetGroup( pVector, &Group, &GroupDesc ); 
      if(nRet != SUCCESS) 
         return nRet; 
      /* Show name in a message box */ 
      MessageBox( NULL, GroupDesc.szName, TEXT("Group Name"), MB_OK ); 
      /* Free the group descriptor because it's no longer needed */ 
      nRet = L_VecFreeGroup( &GroupDesc ); 
   } 
   return nRet; 
} 

Help Version 19.0.2017.10.27
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Vector C API Help