CModel.Parameters: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) (→Syntax) |
Kate Racaza (talk | contribs) No edit summary |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:cModel.Parameters}} | {{DISPLAYTITLE:cModel.Parameters}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}} | ||
{{Template: | |||
Returns an array of parameter | |||
<onlyinclude>Returns an array of '''[[ParamValues Class|ParamValues]]''' objects that represent the parameter name and value pairs of an associated cModel object.</onlyinclude> | |||
== Syntax== | == Syntax== | ||
'''.Parameters()''' | |||
{{APIComment|Get the | ==Example == | ||
'''VBA|VB.NET''' | |||
{{APIComment|...}} | |||
{{APIComment|'Add code to get an existing model or create a new one.}} | |||
{{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel | |||
{{APIComment|...}} | |||
{{APIComment|'Get an array of the model's parameters.}} | |||
{{APIPrefix|Dim}} ModelParameters() {{APIPrefix|As}} ParamValues | |||
ModelParameters = AModel.Parameters() | |||
{{APIComment|'Output example: Display the name and value of the first parameter.}} | |||
Dim ParamName {{APIPrefix|As}} String | |||
Dim ParamValue {{APIPrefix|As}} Double | |||
ParamName = ModelParameters(0).ParamName | |||
ParamValue = ModelParameters(0).Value | |||
MsgBox (ParamName & " = " & ParamValue) | |||
Latest revision as of 17:53, 17 June 2016
 |
Member of: SynthesisAPI.cModel
Returns an array of ParamValues objects that represent the parameter name and value pairs of an associated cModel object.
Syntax
.Parameters()
Example
VBA|VB.NET ... 'Add code to get an existing model or create a new one. Dim AModel As New cModel ... 'Get an array of the model's parameters. Dim ModelParameters() As ParamValues ModelParameters = AModel.Parameters() 'Output example: Display the name and value of the first parameter. Dim ParamName As String Dim ParamValue As Double ParamName = ModelParameters(0).ParamName ParamValue = ModelParameters(0).Value MsgBox (ParamName & " = " & ParamValue)