Hide Table of Contents
GetActiveGroundPlane Method (IAssemblyDoc)

Gets the active ground plane for the specified configurations.

.NET Syntax

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

Parameters

Config_opt

Configurations from which to retrieve active ground planes as defined in swInConfigurationOpts_e:

  • swThisConfiguration
  • swAllConfigurations
  • swSpecifyConfiguration

(see Remarks)

Config_names
Array of the names of configurations from which to retrieve active ground planes; valid only if Config_opt is set to swInConfiguration_e.swSpecifyConfiguration (see Remarks)

Return Value

Array of ground plane features

Example

Remarks

If Config_opt is set to swInConfiguration_e... Then the returned array contains one active ground plane or null for...
swAllConfigurations Each configuration in the assembly.
swSpecifyConfiguration Each configuration in Config_names.
swThisConfiguration The current configuration.

To populate config_names, use IModelDoc2::GetConfigurationNames.

 

See Also

Availability

SOLIDWORKS 2018 FCS, Revision Number 26.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:   GetActiveGroundPlane Method (IAssemblyDoc)
*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) 2018 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.

0.20.59