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.

ReleaseFunctionControl

Group

Utilities

Description

Release the control of the specified function block. See OP_FUNCTIONAL_BLOCK for more information about the available function blocks.

Required Control

None

Usage

RtlabApi.ReleaseFunctionControl(functionalBlock, fbElement )

Input

  • functionalBlock: Functional block which control is to be requested. See OP_FUNCTIONAL_BLOCK.

  • fbElement: Functional block element which control is to be requested. This input is used to specify the acquisition groups or the subsystem id when the functional block are OP_FB_ACQ_GROUP and OP_FB_SIGNAL respectively. Normally, this value is 0.

Output

None

Exception

  • EOK: Success.

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

  • EBADF: Model not specified by previous Connect or OpenProject.

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

  • ENOMEM: Memory allocation error.

  • EINVAL: Invalid function block or priority.

  • ESRCH: Model instance id not found.

Examples

None

Related Items

TakeFunctionControl, OP_FUNCTIONAL_BLOCK.

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