MigsLab SDKARX.SDK documentation
Ctrl K

MongoDB · Types · Procedures and functions

ArxExecuteResult

Definition

Namespace
ARX.SDK.Services
Package
ARX.SDK
C#
public sealed class ArxExecuteResult

What a routine returned: its OUT and INOUT values, its result sets (a procedure's tables, a function's rows) and the messages it sent. No rows-affected count: not every database reports one for a call.

Constructor

  • ArxExecuteResult(string routineName)

    An empty result for a call to this routine; the provider fills it.

    Parameter Type Description
    routineNamestringThe routine's name, which is also the name of the Outputs entity.

Properties

  • const string MessagesKey

    The key under which a failed call's messages are put in Data.

  • ArxEntity Outputs { get; }

    The OUT and INOUT values of a procedure, one attribute per parameter name.

  • ArxResultSetCollection ResultSets { get; }

    The tables a procedure returned (by its cursor parameters' names) or a function's rows (ResultSets[0]).

  • IReadOnlyList<ArxDatabaseMessage> Messages { get; }

    The messages the routine sent while it ran, in order (when CollectMessages).

Methods

  • void AddMessage(ArxDatabaseMessage message)

    Adds a message (providers).

    Parameter Type Description
    messageArxDatabaseMessageA message the routine raised (a notice or warning).
  • T? Value<T>()

    A function's single value: the one column of its one row, converted to T. Default when there is no row or the value is NULL; ARX2003 when there are several rows; ARX1001 when the row has several columns or the value isn't a T.