RowVariableModel.AddVariable Method

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

Adds a user variable to a model.

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

Syntax

'Declaration
Public Overridable Function AddVariable ( _
    key As Object, _
    <OutAttribute> ByRef vid As Integer _
) As Boolean

public virtual bool AddVariable(
    Object key,
    out int vid
)

public:
virtual bool AddVariable(
    Object^ key, 
    [OutAttribute] int% vid
)

abstract AddVariable : 
        key:Object * 
        vid:int byref -> bool 
override AddVariable : 
        key:Object * 
        vid:int byref -> bool 

public function AddVariable(
    key : Object, 
    vid : int
) : boolean

Parameters

• key
  Type: System.Object
  The key for the variable.

• vid
  Type: System.Int32%
  The index of the variable.

Return Value

Type: System.Boolean
true if the user variable is added to the model successfully; false if the model already includes a user variable that is referenced by key or if the model already includes a row that is referenced by key.

Implements

IRowVariableModel.AddVariable(Object, Int32%)

Remarks

The AddVariable method ensures that a user variable that has the specified key is present in the model.

The following table shows the value of vid, depending on key.

.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.

See Also

Reference

RowVariableModel Class

Microsoft.SolverFoundation.Services Namespace