RelativityScriptResult Class

 Relativity Services API
Provides the output of executing a Relativity Script.
Inheritance Hierarchy
System.Object
  kCura.Relativity.Client.RelativityScriptResult

Namespace:  kCura.Relativity.Client
Assembly:  kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
Copy
public class RelativityScriptResult

The RelativityScriptResult type exposes the following members.

Constructors
  NameDescription
Public methodRelativityScriptResult
Initializes a new instance of the RelativityScriptResult class
Top
Properties
  NameDescription
Public propertyArtifacts
Provides a collection of Artifact objects mapped from the Table generated by the script.
Public propertyCount
Indicates the number of rows affected by the script when the ReturnType is Status.
Public propertyMessage
Represents a description of an error when a script failure occurs.
Public propertyReturnType
Retrieves the type of script as Table or Status.
Public propertySuccess
Indicates the status of an operation. Value set to True when the operation succeeds.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
For Scripts configured with the return type of Status, the Count property indicates the number of rows affected by the Script. For Scripts configured with the return type of Table, the Artifacts collection contains the results of the script when it outputs one Integer column with the name of ArtifactID.
See Also

Reference

kCura.Relativity.Client Namespace