Function Documentation Conventions

Function Documentation Conventions

The documentation of each function in the API has the following sections:

Syntax

This section provides the syntax of the command as you would call it from an external application without including any parameters

VB6 Procedure

The VB6 procedure shows the function as defined in SAP2000. This function definition shows the variable type of each parameter, which parameters are optional, and which optional parameters have built-in default values.

See 
Visual Basic Concepts Used in the CSI API
 for more information about Visual Basic definitions that apply to the CSI API.

Parameters

The Parameters used in the function are briefly described. Parameters that have units associated with them are followed by a 
units abbreviation
 in square brackets, such as [F], indicating the units type for the item.

Remarks

The Remarks describe what the function does and provides additional information, if any, that was not explained in the Parameters. See 
Function Return Values
 for more information.

VBA Example

The VBA example uses the considered function. The examples are written for use in Microsoft Excel VBA.

Release Notes

The release information specific to the considered function is provided.

See Also

Functions that are related to the considered function, if any, are listed in this area.

See Also

Introduction

Accessing SAP2000 From An External Application

Function Return Values

Units Abbreviations

Visual Basic Concepts Used in the CSI API