Versions Compared

Key

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

Group

Model Execution

Description

Requests

Request or

releases

release the system control of the currently connected model. System control enables the client API to control the model's execution. Only one client API at a time is granted system control.

Required Control

None

Usage

RtlabApi.GetSystemControl(systemControl)

Input

  • systemControl: True(1) to request system control of the model, False(0) to release its control.

Output

None

Exception

  • EOK: Success.

  • EPERM: Control requested but already given to another client.

  • EBADF: Model not specified by previous Connect or

SetCurrentModel
  • OpenProject.

  • ENOMEM: Memory allocation error.

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

  • ESRCH: Model instance id not found.

Examples

See example basic_example1.

Related Items

Connect, ConnectByName, SetCurrentModel

Modules

import RtlabApi