> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opaltakefunctioncontrol.md).

# OpalTakeFunctionControl

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Utilities</td></tr><tr><td><strong>Description</strong></td><td>Takes the control of the specified function block of the currently connected model. Only one client API at a time is granted a given function block control. See <strong>OP_FUNCTIONAL_BLOCK</strong> for more information about the available function blocks.<br>Example: In order to be able to take a snapshot of the running model, control of the snapshot function block should be first requested using <strong>OpalTakeFunctionControl</strong>(<strong>OP_FB_SNAPSHOT</strong>, 0, 0). As soon as the control is granted, the user can call the OpalSnapshot(...) function.</td></tr><tr><td><strong>Required Control</strong></td><td>Takes the control of the specified function block of the currently connected model. Only one client API at a time is granted a given function block control. See <strong>OP_FUNCTIONAL_BLOCK</strong> for more information about the available function blocks.<br>Example: In order to be able to take a snapshot of the running model, control of the snapshot function block should be first requested using <strong>OpalTakeFunctionControl</strong>(<strong>OP_FB_SNAPSHOT</strong>, 0, 0). As soon as the control is granted, the user can call the OpalSnapshot(...) function.</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalTakeFunctionControl</strong>(OP_FUNCTIONAL_BLOCK fb,unsigned short fbElem, OP_CONTROL_PRIORITY priority);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>fb:</strong> Functional block which control is to be requested. See <strong>OP_FUNCTIONAL_BLOCK.</strong></li><li><strong>fbElem:</strong> Functional block element which control is to be requested. This input is used to specify the acquisition group when the function block is <strong>OP_FB_ACQ_GROUP</strong>. Normally, this value is 0.</li><li><strong>priority:</strong> Control priority to be requested. Higher is the value, higher is the priority. See <strong>OP_CONTROL_PRIORITY</strong>.</li></ul></td></tr><tr><td><strong>Output</strong></td><td>None</td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>EPERM:</strong> Control requested but already given to another client.</li><li><strong>EBADF:</strong> Model not specified by previous OpalConnect or OpalSetCurrentModel.</li><li><strong>EIO:</strong> Error sending the request or receiving the reply.</li><li><strong>ENOMEM:</strong> Memory allocation error.</li><li><strong>EINVAL:</strong> Invalid function block.</li><li><strong>ESRCH:</strong> Model instance id not found.</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>None</td></tr><tr><td><strong>Related items</strong></td><td>OpalReleaseFunctionControl, OP_FUNCTIONAL_BLOCK, OP_CONTROL_PRIORITY.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/rt-lab/automation-api-and-scripting/rt-lab-api/c-rt-lab-api-reference/functions-reference/opaltakefunctioncontrol.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
