OPC Studio User's Guide and Reference
Failure Method (OperationResult)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.OperationModel Namespace > OperationResult Class : Failure Method
Information about the reason of the failure of the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Returns a failed operation result with given exception.
Syntax
'Declaration
 
<NotNullAttribute()>
Public Shared Function Failure( _
   ByVal exception As Exception _
) As OperationResult
'Usage
 
Dim exception As Exception
Dim value As OperationResult
 
value = OperationResult.Failure(exception)
[NotNull()]
public static OperationResult Failure( 
   Exception exception
)
[NotNull()]
public:
static OperationResult^ Failure( 
   Exception^ exception
) 

Parameters

exception
Information about the reason of the failure of the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

The failed operation result.

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

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

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

See Also