SingleResult Method

Returns a single node element from the collection, or an error result if the collection does not contain exactly one element.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
<JetBrains.Annotations.PureAttribute()>
Public Function SingleResult( _
   Optional ByVal state As Object _
) As ValueResult(Of UANodeElement)

'Usage
 
Dim instance As UANodeElementCollection
Dim state As Object
Dim value As ValueResult(Of UANodeElement)
 
value = instance.SingleResult(state)

[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public ValueResult<UANodeElement> SingleResult( 
   object state
)

[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public:
ValueResult<UANodeElement^>^ SingleResult( 
   Object^ state
)

Parameters

state: Optional state object to include in the result.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

A value result containing the single node element if successful, or an error result if the collection is empty or contains multiple elements.

This method never returns null (Nothing in Visual Basic).

This return value of this method should not be ignored.

Remarks

This method is pure, i.e. it does not have observable side effects.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

UANodeElementCollection Class
UANodeElementCollection Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.