NonlinearModel.IsActiveVariable Method

Article
12/06/2011

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Returns a value that indicates whether a variable is active in the specified row.

Namespace: Microsoft.SolverFoundation.Services
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public Function IsActiveVariable ( _
    rowVid As Integer, _
    varVid As Integer _
) As Boolean

public bool IsActiveVariable(
    int rowVid,
    int varVid
)

public:
virtual bool IsActiveVariable(
    int rowVid, 
    int varVid
) sealed

abstract IsActiveVariable : 
        rowVid:int * 
        varVid:int -> bool 
override IsActiveVariable : 
        rowVid:int * 
        varVid:int -> bool

public final function IsActiveVariable(
    rowVid : int, 
    varVid : int
) : boolean

Parameters

rowVid
Type: System.Int32
The row index.

varVid
Type: System.Int32
The variable index.

Return Value

Type: System.Boolean
true if the variable is active; otherwise, false.

Implements

INonlinearModel.IsActiveVariable(Int32, Int32)

Exceptions

Exception	Condition
ArgumentException	rowVid is not a valid row index, or varVid is not a valid variable index.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.