DG Kernel (ActiveX) Documentation


Skip Navigation Links.
Start page
Quick Start
Search Page
Installation
What is new
Upgrading Native Apps
Licensing
Collapse ModelsModels
Models
Persistence
Model Properties
Collapse EntitiesEntities
Collapse GeometryGeometry
Geometry
Collapse BRepBRep
BRep Overview
BRep Geometry
Shapes
Curves
Surfaces
Faces
Wires
Edges
Compounds
Collapse MeshMesh
Mesh Geometry
Mesh
BRep to Mesh Conversion
Curve Geometry
Line Strips
Point Sets
Overlays
Collapse AttributesAttributes
Local Frame
Appearance
Texture
Properties of an Entity
Collapse Model ItemsModel Items
Items
3D Text
Smart Labels
View Points
Collapse MeasurementsMeasurements
Measurements
Persistent Measurements
Grid
Collapse Operations and AlgorithmsOperations and Algorithms
Boolean Operations
Euclidean Shortest Path
Collapse MovementMovement
Movements
Kinematic Entities
Collision Detection
Collapse Import/ExportImport/Export
Import/Export Overview
Data Flow Sample
STL Tree
Collapse DG Kernel ControlsDG Kernel Controls
Components
DG Kernel Control
Collapse Properies, Methods, EventsProperies, Methods, Events
Properies
Methods
Events
Collapse Interactive FunctionalityInteractive Functionality
View
Context Menu
Measurements
Direct User Access
Modes of DG Kernel
Current Entities
Collapse Selection OverviewSelection Overview
Selection
Selection Event
Collapse Auxiliary ViewsAuxiliary Views
Model Explorer
Birds Eye View
Full Screen window
Collapse Programmatic FunctionalityProgrammatic Functionality
Programming
Queries
Data Types
Object Construction
Generator
Component Context
Initialisation Context
Collapse API ReferenceAPI Reference
Interface List
Vector Space
Collapse General GeometryGeneral Geometry
IPointArray_DG
IPointMatrix_DG
IPointCloud_DG
Collapse CurvesCurves
ICurve_DG
ILine_DG
ICircle_DG
IEllipse_DG
IBSplineCurve_DG
IBSplineCurveInterpolator_DG
ICurveFreeForm_DG
IArcSpline3DCurve_DG
Collapse 2D2D
ICurve2d_DG
IBSplineCurve2d_DG
ICircle2d_DG
ILine2d_DG
IArc_DG
Collapse SurfacesSurfaces
IUVSurface_DG
IPartialSplineProps_DG
IBSplineSurface_DG
IBezierSurface_DG
IPartialBezierProps_DG
IRectangularTrimmedSurface_DG
ISurfaceOfRevolution_DG
Collapse Oriented ObjectsOriented Objects
IObjectOriented_DG
IPlane_DG
ISphere_DG
ICylinder_DG
ICone_DG
ITorus_DG
IBox_DG
IPolygon3D_DG
IGeometricObject_DG
Collapse GeneralGeneral
IElement_DG
IStrip_DG
Collapse ModelModel
IModel_DG
Collapse EntitiesEntities
IEntity_DG
IEntityArray_DG
IStdShape_DG
IStdShapeRef_DG
IDraw_DG
IEntity2d_DG
IModel2d_DG
Collapse GeometryGeometry
IGeometry_DG
IPointSetGeometry_DG
ISegmentStripGeometry_DG
ICurveGeometry_DG
ISurfacePoint_DG
ISurfacePointArray_DG
ILabel_DG
ILabelGeometry_DG
ISticky_DG
Collapse BSpline BRep GeometryBSpline BRep Geometry
Collapse Advanced AlgorithmsAdvanced Algorithms
IBRepChamfer_DG
IBRepDraftAngle_DG
IBRepFillet_DG
IFeaturePrism_DG
IBRepShape_DG
IBRepVertex_DG
IBRepEdge_DG
IBRepWire_DG
IBRepFace_DG
IBRepShell_DG
IBRepSolid_DG
IBRepCompositeSolid_DG
IBRepCompound_DG
IShapeArray_DG
IBRepBuilderEx_DG
IWireArrayToSurfaceBuilder_DG
IBRepGeometry_DG
IBRepBuilder_DG
Collapse Mesh GeometryMesh Geometry
IMesh_DG
IMeshGeometry_DG
IVertex_DG
IVertexSegment_DG
ISimplex_DG
IMeshPoint_DG
IMeshAlgor_DG
IDiffSurface_DG
Collapse AppearenceAppearence
IAppearance_DG
IColor
IMaterial_DG
ITexture_DG
ILineStyle_DG
Collapse MovementMovement
Collapse Collision DetectionCollision Detection
IMetrics_DG
IPathCollisionDetector_DG
IKinematicEntity_DG
IMove_DG
IKinematicSet_DG
ICutEffect_DG
ISpinEffect_DG
IConstraint_DG
Collapse ItemsItems
IModelItem_DG
IItemArray_DG
IDynamicScreenItem_DG
IDynamicScreenItemManager_DG
ISmartLabelManager_DG
Collapse Import / ExportImport / Export
IDataContext_DG
ISTLDataContext_DG
Collapse Operations and AgorithmsOperations and Agorithms
IBooleanEntity_DG
IEuclideanShortestPath_DG
Collapse User DataUser Data
IUserData_DG
Collapse ViewView
IView_DG
ISelection_DG
IScene_DG
ILighting_DG
ILightSource_DG
IViewPoint_DG
IViewPointArray_DG
IMeasurement_DG
IRectangleColor_DG
I2DEditor_DG
IVirtualView_DG
Collapse General ComputingGeneral Computing
IObjectGenerator_DG
IControlInitialisationContext_DG
IGlobalAPI_DG
Collections
IUnknown
IObject_DG
IBitmap_DG
IBlob_DG
IContext_DG
IError_DG
IKCStack
IMenu_KC
IMenuItem_KC
IText
IFont_DG
Collapse ViewsViews
View
Scene
Global Axes
Background
3D Background
Collapse Samples and TutorialsSamples and Tutorials
Sample List
.NET Samples
Delphi and C++ Samples
Collapse GraphicsGraphics
Concepts
3D View
Viewing Volume
Eye Frame
Perspective View
Collapse Math ObjectsMath Objects
Mathematical Objects
Planes
Frames
Transforms
Oriented Objects
Boxes
Collapse CurvesCurves
Curve Technologies
Native Curves
Collapse 2D Elements2D Elements
Geometric Elements
Arcs
Line Strips
Collapse DeprecatedDeprecated
Collapse Deprecated GeometryDeprecated Geometry
Collapse 3DS3DS
Profiles
Surface Patches
Surfaces and Patch Strips
Input Validation
Collapse Lines and CurvesLines and Curves
3DS Curves
Surface Of Revolution
Collapse Deprecated API ReferenceDeprecated API Reference
Collapse ModelModel
Collapse SectionSection
IBoundary
Collapse 3DS3DS
IProfiles
IProfiledElement_KC
Redistribution
Model Viewer
Open Source
Support
Skip Navigation Links Go to DGKC docs Search Documentation


IArray2 Interface

GetCount
GetAt
InsertAt
RemoveAt
Add
Find
InsertNew
SetCount
SetAt
RemoveAll

IArray2 is an expansion of IArray interface, which has added InsertNew method. It also can be used by environments which do not recognize IUnknown data type. IArray2 implementing a property has to be queried via the correspondent IArray.

See also Object Array Sample, Interface List


HRESULT GetCount(int * pnCount)

Parameters

pnCount- [out, retval] Reference to an integer variable which will be set to number of valid members in the array

Returns

S_OK in case of success.

HRESULT GetAt(int index, VARIANT* val)

Parameters

index - [in] index of the object to retrieve.

val - [out, retval] pointer to a VARIANTvariable, which will be assigned an appropriate  interface pointer, implemented by index-th object in the array.

Return Values

S_OK in case of success.

DISP_E_BADINDEX - if the index is out of the range

DISP_E_PARAMNOTOPTIONAL - if the object is not available.

Remarks:
 
The type vt of the VARIANT is VT_UNKNOWN. The returned value is contained in punkVal member of the VARIANT and has type of IUnknown.  This method gives access to index-th object in the array. Most often actual type of the interface is different from IUnknown and can be cast to the specific type, which is described for each specific use of the IArray interface. 

HRESULT InsertAt(int index, VARIANT* val)

Parameters

index - [in] index of the newly added object.

val - [in] VARIANT, containing a reference to an IUnknown interface to be inserted in the array. Depending on the specific type of objects in the array if the I Unknown reference is NULL a new default object will be inserted at the position. 

Returns

S_OK in case of success.

Remarks:
 This method will insert the reference to the object contained in the val at position index. All other members will be shifted up. Size of the array will be incremented by 1. The type vt of the VARIANT must be VT_UNKNOWN. The value must be contained in punkVal member of the VARIANT and have type of IUnknown.


HRESULT RemoveAt(int index)

Parameters

index - [in] index of the object to be removed..

Returns

S_OK in case of success.

Remarks:
Will remove the object at index position. 


HRESULT Add(VARIANT* val)

Parameters

val - [in] VARIANT, containing a reference to an I Unknown interface to be added to the array. Depending on the specific type of objects in the array if I Unknown reference is NULL a new default object added at the end of the array. 

Returns

S_OK in case of success.

Remarks:

The method will insert the reference to the object contained in the val at the end of the array. The type vt of the VARIANT must be VT_UNKNOWN. The value must be contained in punkVal member of the VARIANT and have type of IUnknown. 


HRESULT Find(VARIANT * val, int* pnIndex)

Parameters

val - [in] VARIANT, containing a reference to an I Unknown interface to be found in the array. Note that any interface of any type can be supplied for this parameter.

pnIndex - [out] Reference to an integer variable, which will receive 0-based index of the object in the array or -1 if not found.

Returns

S_OK. - Always.

Remarks:

If the array contains the object implementing the IUnknown reference, contained in the val,  its 0- based index will be returned in pnIndex. Otherwise pnIndex will be set to -1.


HRESULT InsertNew(int type, int indexAt)

Parameters

type - [in] Depending on context when there several types of object can be kept in the array this parameters identifies type of the object, which is requested to be created and inserted in the array. Documentation for specific property describes valid values for this parameter.

indexAt - [in] 0-based index of the new object in the array. It must be between 0 and the current size of array.

Returns

S_OK. - If succeeded.

DISP_E_BADINDEX - when indexAt is negative or exceeds the current size of the array.

Remarks:

The method creates a new object of type type. In the context when only one type of object can be added to the array type parameter is ignored and can be set to any non-negative integer. Documentation for specific property describes valid values for this parameter.


HRESULT SetCount(int count)

Parameters

count - [in] New size of the array.

Returns

S_OK. - If succeeded.

ERROR_CALL_NOT_IMPLEMENTED - when count is greater than the current size and there is no default constructor of new objects for the array

Remarks:

When count is greater than the current size the method creates a number of new default objects and add them to the array. If there is no default constructor of new objects for the array the method returns error code ERROR_CALL_NOT_IMPLEMENTED.

When count is less than the current size the last several objects are removed from the array. The remaining elements will not change any properties. count can be zero, which empties the array.

Use SetCount(0) to remove all elements from the array.


HRESULT SetAt(int index, VARIANT* val)

Parameters

index - [in] 0-based index of in the array. It must be less than the current size of the array.

val - [in] VARIANT, containing a reference to an IUnknown interface to be stored in the array.


HRESULT RemoveAll()

Empties the array.