LVectorBase::GetGroupByIndex

Summary

Gets the group at the specified index in the class object's vector handle.

Syntax

#include "ltwrappr.h"

virtual L_INT LVectorBase::GetGroupByIndex(nIndex, pVectorGroup)

Parameters

const L_INT nIndex

Index of the requested group. This index is zero-based. Possible values are between 0 and LVectorBase::GetGroupCount - 1.

LVectorGroup *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

Value Meaning
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

See Also

Functions

Topics

Example

For an example, refer to LVectorDialog::DoModalVectorEditGroup.

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

LEADTOOLS Vector C++ Class Library Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.