Make a Collection Item Name Reference List - Wildcard Selection

Builds a Collection Item Names which can be used to identify any item. An “Item” is a generic term that can apply to anything in the tree other than specific points. This includes things that are not objects such as reports or charts or GD&T annotations for example. Creates a list of objects through the use of wildcard criteria.

 

Input Arguments

 

0

String

Collection Wildcard Criteria

The wildcard string to specify the collections to select from.

1

String

Object Wildcard Criteria

The wildcard string to specify the items to select

from.

2

Collection Item Type

Item Type

A filter to only select objects of this type.

 

Return Arguments

 

3

Collection Object Name Ref List

Resultant Collection Object Name Reference List

The resulting list of items matching the specified wildcard selection criteria.

 

Returned Status

 

SUCCESS

The matching list of items was created successfully.

FAILURE

The wildcard criteria strings were invalid.

 

Remarks

This command may return an empty list. The order of the objects in the list is undefined.

Enter wildcard values for the collection and object using the same conventions as elsewhere in SA. Asterisks (*) are wildcards for one or more characters, while question marks (?) are placeholders for single characters. Specific char- acters can also be found using brackets[]. To find all objects that start with “s” from all collections, use a collection criteria of * and an object wildcard criteria of s*.

 

Builds a Collection Object Name from Strings which can be used to identify an object.

 

Input Arguments

 

0

String

Collection

The collection to use in the collection object name.

1

String

Object

The object to use in the collection object name.

2

Object Type

Object Type

The type for the object.

 

Return Arguments

 

3

Collection Object Name

Resultant Collection Object Name

The resulting collection object name from the command.

 

Returned Status

 

SUCCESS

This command always succeeds.

 

Remarks

None.