GetObject (Dictionary)

Description

Returns an existing object that corresponds to a full path name. In other words, it converts from a string representation of a Softimage object to the Object Model representation. This is similar to the GetValue command. However, in the case of Parameter objects, Dictionary.GetObject returnz the Parameter object and GetValue returns the parameter value (see the example below).

To convert in the other direction (from an Object Model representation to a string), use SIObject.FullName.

Scripting Syntax

Dictionary.GetObject( Pathname, [ThrowError] )

C# Syntax

Object Dictionary.GetObject( String in_bszObjectName, Boolean in_bThrowError );

Parameters

Parameter

Type

Description

Pathname

String

Full path name of the object to find.

ThrowError

Boolean

By default Softimage will cause a script error if the object does not exist. If you are not sure if the object exists or not pass false as the value of this argument and Softimage will return null rather than throwing an error. This parameter is new starting with v5.0.

Default Value: true

Return Value

The found object.

See Also

GetValue

SIObject

Parameter

Examples

• See Dictionary.GetObject.1.vbs

• See Dictionary.GetObject.2.js

• See Dictionary.GetObject.3.vbs

• See Dictionary.GetObject.4.js



Autodesk Softimage 2011