Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Group

Model Interaction, Parameters

Description

Requests

Request or

releases

release the parameter control of the currently connected model. Parameter control allows the client API to change the values of models'

s

parameters. Only one client API at a time is granted parameter control.

Required Control

None

Usage

GetParameterControl(parameterControl)

Input

  • parameterControl: True(1) to request control of model parameters, False(0) to release control.

Output

None

Exception

  • EOK: Success.

  • ENOMEM: Memory allocation error.

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • EPERM: Could not get parameters control.

  • EIO: Error sending the request or receiving the reply.

Examples

See example parameter1.

Related Items

SetParameters, SetParametersByName

Modules

import RtlabApi