How to Read th e C# and Scripting Reference Entries

The kind of information available for each entry does not vary in this guide. For example, every entry contains a basic description of the item, but only methods and commands contain a demonstration of the syntax.

The following table gives a list of the kinds of information on each entry and an explanation of what to expect from it:

Heading Name | What Kind of Information It Provides | Where It Appears
Scripting Syntax | Demonstrates how to use the command or method. The name of the command or method appears first, followed by all the available parameters inside parentheses. Square brackets indicate that the parameter is optional. | Commands, Methods
C# Syntax | Displays the signature of the method or property for developing compiled plug-ins with C#. Note: In the event ot a discrepancy between the information presented in the Scripting Syntax section vs. the C# Syntax section, the C# Syntax section should be considered correct. | Methods, Properties
Description | Provides information about the entry. Sometimes includes information about the context of the entry or its usability. | All entries
Parameters | Details on the parameters that appear in the syntax strings of the commands or methods. Information is organized in a table with columns for the parameter name, the data type of the parameter, and a general description of the parameter. The description may also include the Default Value for the parameter or a list of Possible Values. Sometimes hyperlinks to an entry for a constant or a description of the data type are available. | Commands, Methods, Properties
Port Description | Details on the input and output port definition for each fundamental ICE Node available in Softimage, including any restrictions on type, structure, or context. Information is organized in input and output tables with columns for the port name, connection information, and a general description of the port. For input ports, the PortGroup ID and number of allowable instances are also included. | ICE Nodes
Return Value | Indicates what kind of value is returned by the command, method, or property. Sometimes hyperlinks are included; for example, the return value of AddGeometry is given as a hyperlink to the X3DObject entry. For more information on return values, see Returning Values. | Commands, Methods, Properties
Methods | Provides a table containing all the available methods for the current object as hyperlinks. This list includes methods that are implemented on the current object itself, as well as those that are inherited. | Objects
Properties | Provides a table containing all the available properties for the current object as hyperlinks. This list includes properties that are implemented on the current object itself, as well as those that are inherited. | Objects
Examples | Demonstrates how to use the current entry in a script fragment or a subroutine. Examples are usually written in VBScript, although there are some examples in JScript or C++. You can copy and paste these script fragments directly into the Script Editor (for the languages written in a scripting language), as they are intended to run independently of any setup on the part of the user. | Commands, Objects, Methods, Properties, ICE Nodes
See Also | Provides hyperlinks to related commands, objects, methods, properties, and constants. For objects, this section may also provide hyperlinks to the methods or properties that create these objects. For example, the See Also section of the Null object includes a hyperlink to the AddNull method of the X3DObject collection. | Commands, Objects, Methods, Properties, ICE Nodes
Applies To | Provides hyperlinks to the reference entries that use the current constant. For example, the siSeverity constant is used in the LogMessage method of the Application object. Generally, a reference entry that uses a constant will also provide a hyperlink in its parameter table back to the constant. | Constants

Autodesk Softimage v7.5