MigsLab SDKARX.SDK documentation
Ctrl K

MySQL · Types · Procedures and functions

ArxProcedureParameter

Definition

Namespace
ARX.SDK.Query
Package
ARX.SDK
C#
public sealed class ArxProcedureParameter

One parameter of a routine: by name or by position (Name null), with its value and, when needed, its type.

Constructor

  • ArxProcedureParameter(string? name, object? value, Type? type, ArxProcedureParameterDirection direction)

    A parameter; the AddParameter methods of ArxProcedureExpression create them.

    Parameter Type Description
    namestring?The parameter's name in the routine; null to pass it by position.
    valueobject?The value passed in (null for an OUT parameter).
    typeType?Its .NET type, when the value alone doesn't say (a null, an OUT or INOUT parameter).
    directionArxProcedureParameterDirectionIn, Out, InOut, a cursor or a variadic list.

Properties

  • string? Name { get; }

    The parameter's name in the routine; null for a positional argument.

  • object? Value { get; }

    The value passed in (null for OUT and cursor parameters). Sent as a typed parameter, like a write's value.

  • Type? Type { get; }

    The declared .NET type: required for OUT and INOUT, and for a null the database must type; null otherwise.

  • ArxProcedureParameterDirection Direction { get; }

    In, Out, InOut, a cursor or a variadic list.

Usage

C#

A line from a verified sample; the full, runnable code is on its page.

untyped.Parameters.Add(new ArxProcedureParameter("p_orders", null, null, ArxProcedureParameterDirection.Out));

Handle Execute errors, scenario 2

Used in: