> IGetComponents Method (IAssemblyDoc)
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show Table of Contents
IGetComponents Method (IAssemblyDoc)

Gets all of the components in the active configuration of this assembly.

.NET Syntax

Visual Basic (Declaration) 
Function IGetComponents( _
   ByVal TopLevelOnly As Boolean, _
   ByVal Count As Integer _
) As Component2
Visual Basic (Usage) 
Dim instance As IAssemblyDoc
Dim TopLevelOnly As Boolean
Dim Count As Integer
Dim value As Component2
 
value = instance.IGetComponents(TopLevelOnly, Count)
C# 
Component2 IGetComponents( 
   bool TopLevelOnly,
   int Count
)
C++/CLI 
Component2^ IGetComponents( 
&   bool TopLevelOnly,
&   int Count
)

Parameters

TopLevelOnly
True to get only the number of components at the top level of the FeatureManager design tree, false to get the number of top level and all child components in the FeatureManager design tree
Count
Number of components

Return Value

  • in-process, unmanaged C++: Pointer to an array of IComponent2
  • VBA, VB.NET, C#, and C++/CLI: Not supported

    • See In-process Methods for details about this type of method.

    Remarks

    Before using this method, use IAssemblyDoc::GetComponentCount to determine the size of the array to pass to this method.

     

    The components returned by this method can be in any order. You should not rely on the order to indicate anything about children or parents. If the hierarchy and order are important, then use IModelDoc2::FirstFeature, IFeature::GetTypeName2, IFeature::GetSpecificFeature2, IComponent2::FirstFeature, and IFeature::GetNextFeature to retrieve your information.

     

    See Also

    Availability

    SolidWorks 2006 FCS, Revision Number 14.


    Related SolidWorks Forum Content

    Provide feedback on this topic

    SolidWorks welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

    * Required

     
    *Email:  
    Subject:   Feedback on Help Topics
    Page:   IGetComponents Method (IAssemblyDoc)
    *Comment:  
    x

    We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

     Never show this message again
    x

    Web Help Content Version: API Help (English only) 2012 SP05

    The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document API Help (English only) 2012 SP05.

    To disable Web help from within SolidWorks and use local help instead, click Help > Use SolidWorks Web Help.

    To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.