LVectorGroup::LVectorGroup

Summary

Constructs and initializes the different member variables of the LVectorGroup object.

Syntax

LVectorGroup::LVectorGroup(pGroup, pVector=NULL)

LVectorGroup::LVectorGroup(pVector)

LVectorGroup::LVectorGroup(pGroupDesc=NULL, pVector=NULL)

Parameters

pVECTORGROUP pGroup

Pointer to a VECTORGROUP structure that contains information used to create and initialize the new vector group.

LVectorBase * pVector

Pointer to an LVectorBase object. The newly created vector group will be associated with this LVectorBase object.

pVECTORGROUPDESC pGroupDesc

Pointer to a VECTORGROUPDESC structure that contains information used to create and initialize the new vector group.

Returns

None

Comments

LVectorGroup::LVectorGroup(pGroup, pVector=NULL) is a constructor for the LVectorGroup object. It takes a valid pVECTORGROUP pointer and creates an LVectorGroup object. This constructor should mainly be used with the LVectorBase::EnumGroups function, which returns a valid pVECTORGROUP pointer in its LVectorBase::EnumGroupsCallBack member function.

LVectorGroup::LVectorGroup(pVector) creates a valid LVectorGroup object that is associated with the specified LVectorBase object.

LVectorGroup::LVectorGroup(pGroupDesc=NULL, pVector=NULL) creates an LVectorGroup object based on the information provided in pGroupDesc and associates the newly created LVectorGroup object with the specified LVectorBase object.

To use the LVectorGroup::LVectorGroup(pGroupDesc=NULL, pVector=NULL) constructor, optionally declare a variable of type VECTORGROUPDESC, fill the structure and pass its address to this constructor. To associate the newly created vector group with an LVectorBase object, pass a valid pointer to an LVectorBase object as the second parameter. If the second parameter is NULL, then the LVectorGroup object is not yet associated with an LVectorBase object. The following functions automatically associate an LVectorGroup object with an LVectorBase object: LVectorBase::AddGroup, LVectorBase::GetGroupByName and LVectorBase::GetGroupByIndex. The LVectorGroup::SetVector also associates an LVectorGroup object with an LVectorBase object.

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

• LVectorGroup::~LVectorGroup
• LVectorBase::AddGroup
• LVectorBase::GetGroupByName
• LVectorBase::GetGroupByIndex
• LVectorGroup::SetVector
• Class Members

Example

This is an example for LVectorGroup::LVectorGroup(pVector):
For an example for LVectorGroup::LVectorGroup(pGroupDesc=NULL, pVector=NULL), refer to LVectorBase::AddGroup.
For an example for LVectorGroup::LVectorGroup(pGroup, pVector=NULL), refer to LVectorBase::EnumGroups.

L_INT LVectorGroup__LVectorGroupExample(HWND hWnd, LVectorBase *pVector) 
{ 
   UNREFERENCED_PARAMETER(hWnd); 
 
   LVectorGroup VectorGroup(pVector); 
 
   //...Do something with the vector group 
 
   //...LVectorGroup destructor called when VectorGroup goes out of scope 
 
   return SUCCESS; 
}