Query Method

Description

Queries for Variable objects from a filter on the name, and returns a VariableList object.

Syntax

Visual Basic
Public Function Query( _ ByVal pFindCriterium As String, _ Optional ByVal NamedBy As Variant, _ Optional ByVal VarType As Variant, _ Optional ByVal CaseInsensitive As Variant _ ) As Object

Parameters

pFindCriterium: Specifies the filter to be applied to the search.
NamedBy: A value from the VariableNameBy Enumeration.
VarType: A value from the VariableVarType Enumeration.
CaseInsensitive: A Boolean value of either True or False.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeframework.Application
    Dim objDoc As SolidEdgepart.PartDocument
    Dim objVariables As SolidEdgeframework.Variables
    Dim objVariable As SolidEdgeframework.variable
    Dim objVar1 As SolidEdgeframework.variable
    Dim objVar2 As SolidEdgeframework.variable
    Dim objVars As Object
    ' Report errors
    Const PI = 3.14159265358979
    ' Create/get the application with specific settings
    On Error Resume Next
    Set objApp = GetObject(, "SolidEdge.Application")
    If Err Then
        Err.Clear
        Set objApp = CreateObject("SolidEdge.Application")
        Set objDoc = objApp.Documents.Add("SolidEdge.PartDocument")
        objApp.Visible = True
    Else
        Set objDoc = objApp.ActiveDocument
    End If
    'Get Variables Collection
    Set objVariables = objDoc.Variables
    'Create a variable with Add method
    Set objVariable = objVariables.Add(pName:="Variable1", pFormula:="100.0")
    'Create a variable specifying UnitType
    Set objVar1 = objVariables.Add(pName:="Variable2", pFormula:="100 mm", UnitsType:=igUnitDistance)
    'Create a variable with Formula
    Set objVar2 = objVariables.Add(pName:="Variable3", pFormula:="Variable1 * Variable2", UnitsType:=igUnitArea)
    'Query for all variables whose name begins with "Vari"
    Set objVars = objVariables.Query(pFindCriterium:="Vari*")
    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objVariables = Nothing
    Set objVariable = Nothing
    Set objVar1 = Nothing
    Set objVar2 = Nothing
    Set objVars = Nothing
End Sub