[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.
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
'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
The key for the variable.
The index of the variable.
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 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.
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 user variable associated with key is added to the model.
vid is set to the new 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.