Documentation Home Page ◇ RT-LAB Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

GetParameterControl

Owned by Sylvain Ménard
Last updated: May 16, 2023
1 min read

Group

Model Interaction, Parameters

Description

Request or release the parameter control of the currently connected model. Parameter control allows the client API to change the values of models' 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 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

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323