Namespace: Autodesk.Revit.DB.Analysis Class: SpatialFieldManager

SpatialFieldManager.RegisterResult

Method

Description:
Registers result and assigns it a unique result index

Syntax

public int RegisterResult(
	AnalysisResultSchema resultSchema
)

Public Function RegisterResult ( 
	resultSchema As AnalysisResultSchema
) As Integer

public:
int RegisterResult(
	AnalysisResultSchema^ resultSchema
)

member RegisterResult : 
        resultSchema : AnalysisResultSchema -> int

Examples

// register a new result schema only if one with the same name does not already exist
IList<int> registeredResults = new List<int>();
AnalysisResultSchema resultSchema = new AnalysisResultSchema("Reactions", "Reaction Forces at Column Base");
registeredResults = spatialFieldManager.GetRegisteredResults();
int resultIndex = 999;
foreach (int myInt in registeredResults)
{
   if (spatialFieldManager.GetResultSchema(myInt).Name == "Reactions")
   {
      resultIndex = myInt;
      break;
   }
}
if (resultIndex == 999) // there are existing registered results, but none are named "Reactions"
   resultIndex = spatialFieldManager.RegisterResult(resultSchema);

' register a new result schema only if one with the same name does not already exist
Dim registeredResults As IList(Of Integer) = New List(Of Integer)()
Dim resultSchema As New AnalysisResultSchema("Reactions", "Reaction Forces at Column Base")
registeredResults = spatialFieldManager.GetRegisteredResults()
Dim resultIndex As Integer = 999
For Each myInt As Integer In registeredResults
    If spatialFieldManager.GetResultSchema(myInt).Name = "Reactions" Then
        resultIndex = myInt
        Exit For
    End If
Next
If resultIndex = 999 Then
    ' there are existing registered results, but none are named "Reactions"
    resultIndex = spatialFieldManager.RegisterResult(resultSchema)
End If

Parameters

Parameter	Type	Description
resultSchema	AnalysisResultSchema	Result schema to be registered

Return Value

Type	Description
Int32	Unique index assigned to the result

Exceptions

Exception	Condition
ArgumentException	name of resultSchema is not unique in view
ArgumentNullException	A non-optional argument was null