Hide Table of Contents
GetEntityState Method (IAttribute)

Returns the state of the associated entity.

.NET Syntax

Visual Basic (Declaration) 
Function GetEntityState( _
   ByVal WhichState As Integer _
) As Boolean
Visual Basic (Usage) 
Dim instance As IAttribute
Dim WhichState As Integer
Dim value As Boolean
 
value = instance.GetEntityState(WhichState)
C# 
bool GetEntityState( 
   int WhichState
)
C++/CLI 
bool GetEntityState( 
&   int WhichState
) 

Parameters

WhichState

Entity state are defined in swAssociatedEntityStates_e

Return Value

True if the query state matches WhichState, false if not

Example

Remarks

If the attribute is not associated to any entity (that is, it is associated to the document), all queries return false.

The WhichState argument can take any of the values in the swAssociatedEntityStates_e, where:

  • swIsEntityInvalid is a general query. It returns True when the associated entity is not valid due to a suppression or modeling operation.
  • swIsEntitySuppressed is a more specific query. It returns True only if the associated entity is not valid due to a suppression.

IAttribute::GetEntity and IAttribute::IGetEntity2 return NULL when the attribute is associated with:

  • the document
  • an invalid entity
  • a suppressed entity

For example, if an attribute is applied to a face on a boss feature and then that boss feature is suppressed, your application might make the following calls:

  • IAttribute::GetEntity - Returns NULL
  • IAttribute::GetEntityState(swIsEntityInvalid) - Returns True to indicate possibly a suppressed or deleted entity
  • IAttribute::GetEntityState(swIsEntitySuppressed) - Returns True to indicate that the entity is currently suppressed
 

See Also



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:   GetEntityState Method (IAttribute)
*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) 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.