All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

SchListOfBSTRs (Object)

Represents a non-persistant list of character strings to be used with Schematic IDLs.

Property Index

Count
Returns the number of character strings in the list.

Method Index

Append
Adds a character string to the end of the list.
Item
Returns a character string from its index in the list.
RemoveByIndex
Remove a character string from the list by specifying its position in the list.

Properties


o Property Count() As long (Read Only)
Returns the number of character strings in the list.
Example:
This example retrieves in NumberOfStrings the number of character strings currently gathered in MyList. 
 NumberOfStrings = MyList.Count

Methods


o Sub Append(CATBSTR iBSTR)
Adds a character string to the end of the list.
Parameters:
iBSTR
The character string to be added to the list.
Example:
The following example appends a string to the list. 
 Dim MyList As SchListOfBSTRs
 MyList.Append("MyString")
o Func Item(long iIndex) As CATBSTR
Returns a character string from its index in the list.
Parameters:
iIndex
The index of the first character string in the collection is 1, and the index of the last character string is Count.
Returns:
the retrieved string.
Example:
The following example returns in the third character string in the list. 
 Dim MyStr As String
 Dim MyList As SchListOfBSTRs
 Set MyStr = SchListOfBSTRs.Item(2)
o Sub RemoveByIndex(long iIndex)
Remove a character string from the list by specifying its position in the list.
Parameters:
iIndex
The position of the character string to be removed in the list.
Example:
The following example removes the second entry in the list. Please note that the list index starts with 1. 
 Dim MyList As SchListOfBSTRs
 MyList.Remove(1)

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