All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

StrParam (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---Parameter
            |
            +---StrParam
 


Represents the string parameter.
The following example shows how to create it:
	Dim CATDocs As Documents
 Set CATDocs = CATIA.Documents
 Dim part1 As Document
 Set part1   = CATDocs.Add("CATPart")
 Dim material As String
 Set material = part1.Parameters.CreateString("material", "glass")
 

Property Index

Value
Returns or sets the string parameter value.

Method Index

GetEnumerateValues
Returns an array containing the different values that the real param can take in the case of multiple values.
GetEnumerateValuesSize
Returns the number of enumerate values.
SetEnumerateValues
Sets an array containing the different values that the StrParam object can take in the case of multiple values.
SuppressEnumerateValues
Resets the status of the object to a single value object.

Properties


o Property Value() As CATBSTR
Returns or sets the string parameter value.
Example:
This example returns in myValue the value of the string parameter material:
 
 myValue = material.Value
 

Methods


o Sub GetEnumerateValues(CATSafeArrayVariant oSafeArray)
Returns an array containing the different values that the real param can take in the case of multiple values.
Example:
 Dim enumValues () as Variant
 ReDim enumValues (aStrParameter.GetEnumerateValuesSize() - 1)
 aStrParameter.GetEnumerateValues(enumValues)
 For i = LBound(enumValues) to UBound(enumValues)
   ...
 Next
 
o Func GetEnumerateValuesSize() As long
Returns the number of enumerate values.
o Sub SetEnumerateValues(CATSafeArrayVariant iSafeArray)
Sets an array containing the different values that the StrParam object can take in the case of multiple values.
Parameters:
The
array of enumerated values.
o Sub SuppressEnumerateValues()
Resets the status of the object to a single value object.

Copyright © 2003, Dassault Systèmes. All rights reserved.