Hide Table of Contents
SetExcludeFromBOM2 Method (IComponent2)

Sets whether to exclude this component from the bills of materials (BOMs) in the specified configurations.

.NET Syntax

Visual Basic (Declaration) 
Function SetExcludeFromBOM2( _
   ByVal Exclude As System.Boolean, _
   ByVal Config_opt As System.Integer, _
   ByVal Config_names As System.Object _
) As System.Integer
Visual Basic (Usage) 
Dim instance As IComponent2
Dim Exclude As System.Boolean
Dim Config_opt As System.Integer
Dim Config_names As System.Object
Dim value As System.Integer
 
value = instance.SetExcludeFromBOM2(Exclude, Config_opt, Config_names)
C# 
System.int SetExcludeFromBOM2( 
   System.bool Exclude,
   System.int Config_opt,
   System.object Config_names
)
C++/CLI 
System.int SetExcludeFromBOM2( 
&   System.bool Exclude,
&   System.int Config_opt,
&   System.Object^ Config_names
) 

Parameters

Exclude
True to exclude it, false to not
Config_opt
Configuration option as defined in swInConfigurationOpts_e
Config_names
Array of the names of configurations for which to set Exclude; null or Nothing if Config_opt is set to swInConfigurationOpts.swAllConfiguration or swInConfigurationOpts.swThisConfiguration

Return Value

Return code as defined in swExcludeFromBOMError_e

Remarks

This method is valid only for table-based bills of materials; it does not work for Microsoft Excel-based bills of materials.

If you set Exclude to true, the name of the component changes in the FeatureManager design tree of the specified configuration; (Excluded from BOM) is appended. To update the FeatureManager design tree, call IFeatureManager::UpdateFeatureTree.

 

See Also

Availability

SOLIDWORKS 2019 FCS, Revision Number 27.0


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:   SetExcludeFromBOM2 Method (IComponent2)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

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) 2019 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.