> 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/opalgetactivemodels-deprecated.md).

# OpalGetActiveModels (deprecated)

<table data-header-hidden><thead><tr><th width="199.77777099609375"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Selection</td></tr><tr><td><strong>Description</strong></td><td><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This function is for backward compatibility only. Please consider using <strong>OpalGetActiveProjects</strong> instead.</p></div><p>Returns a list of active models (see Glossary). The returned names include the file extension (if any) of the original model file.<br>If the allocated storage is too small for the number of models, or for the longest name or longest path, none of the names, paths or instance Ids are returned, but the numModels, maxNameLen and maxPathLen values are set, and the return value is E2BIG. An application can use this fact to specify lengths of 0 on a first call, allocate the required storage and issue a second call to get the information.</p></td></tr><tr><td><strong>Required Control</strong></td><td>None</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalGetActiveModels</strong>(unsigned sFindObjectIdhort allocatedModels,unsigned short *numModels, unsigned short allocatedNameLen, unsigned short *maxNameLen, unsigned short allocatedPathLen, unsigned short *maxPathLen, char *name[],char *path[], OP_API_INSTANCE_ID instId[]);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>allocatedModels:</strong> number of models for which storage was allocated by the caller for the names, paths and instance ids.</li><li><strong>allocatedNameLen:</strong> allocated length of storage to receive the names</li><li><strong>allocatedPathLen:</strong> allocated length of storage to receive the paths</li></ul></td></tr><tr><td><strong>Output</strong></td><td><ul><li><strong>numModels:</strong> pointer to where the API will store the actual number of active models.</li><li><strong>maxNameLen:</strong> pointer to where the API will store the length of the longest name.</li><li><strong>maxPathLen:</strong> pointer to where the API will store the length of the longest path.</li><li><strong>name:</strong> array of strings where the API will store the names of the active models (includes the extension).</li><li><strong>path:</strong> array of strings where the API will store the paths of the active models.</li><li><strong>instId:</strong> array where the API will store the instance Ids of the active models.</li></ul></td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>EIO:</strong> Error sending the request or receiving the reply.</li><li><strong>E2BIG:</strong> specified storage not big enough to receive values</li><li><strong>ENOMEM:</strong> Internal memory allocation error.</li><li><strong>OP_API_EBAD_CONFIG:</strong> Node mapping not valid or IP address of the controller machine not specified (environment variable OPAL_META_CTL_IP not set).</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>None</td></tr><tr><td><strong>Related items</strong></td><td>OpalGetActiveProjects, OpalDisconnect, OpalSetCurrentModel, OpalConnectByName</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/opalgetactivemodels-deprecated.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.
