Collapse All Expand All

LVectorGroup::GetGroupDesc

#include "ltwrappr.h"

virtual L_INT LVectorGroup::GetGroupDesc(pGroupDesc = NULL)

pVECTORGROUPDESC pGroupDesc;

/* pointer to a structure */

Gets group information for the class object's associated group.

Parameter	Description
pGroupDesc	Pointer to a VECTORGROUPDESC structure to be updated with the group information if the group is found.

Returns

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

Comments

This function updates the m_Desc member variable of the LVectorGroup object.

This function can be used in conjunction with LVectorGroup::SetGroupDesc to change group properties. LVectorGroup::GetGroupDesc and LVectorGroup::SetGroupDesc should be called in pairs.

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::AddGroup, LVectorBase::GetGroupByIndex, LVectorBase::GetGroupByName, LVectorBase::GetGroupCount
Topics:	Working with Vector Groups

Example

For an example, refer to LVectorBase::AddGroup.