LEADTOOLS Vector C++ Class Library Help
| LEADTOOLS Vector C++ Class Library Help > Classes and Member Functions > LVectorBase > LVectorBase Class Members > LVectorBase::GetGroupByIndex |
#include "lvkrn.h"
virtual L_INT LVectorBase::GetGroupByIndex(nIndex, pVectorGroup)
|
const L_INT nIndex; |
/* Index */ |
|
LVectorGroup *pVectorGroup; |
/* pointer to a vector group object */ |
Gets the group at the specified index in the class object's vector handle.
|
Parameter |
Description |
|
nIndex |
Index of the requested group. This index is zero-based. Possible values are between 0 and LVectorBase::GetGroupCount - 1. |
|
pVectorGroup |
Pointer to an LVectorGroup object to be updated, if the group is found. If the group is not found, this function will return ERROR_VECTOR_GROUP_NOT_FOUND. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To determine the number of groups in a vector handle, call LVectorBase::GetGroupCount.
To get a group, given the name of the group, use LVectorBase::GetGroupByName.
To get group information for a specific group, call LVectorGroup::GetGroupDesc.
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::GetGroupCount, LVectorBase::GetGroupByName, LVectorGroup::GetGroupDesc |
|
Topics: |
Example
For an example, refer to LVectorDialog::DoModalVectorEditGroup.
