Export (0) Print
Expand All

ILinearModel.AddVariable Method

Solver Foundation 3.0

[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 user variable is added to a model.

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

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

Parameters

key
Type: System.Object
A key for the row.
vid
Type: System.Int32%
A variable index.

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.

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

key in the model

Value of vid

The model already includes a user variable that is referenced by key.

vid is set to the variable index.

The model already includes a row that is referenced by key.

vid is set to -1.

A new variable that is associated with key is added to the model.

vid is set to the new variable index.

Show:
© 2014 Microsoft