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

# OpalGetActiveProjects

<table data-header-hidden><thead><tr><th width="199.77783203125"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Selection</td></tr><tr><td><strong>Description</strong></td><td>Returns a list of active projects. For each project, this function returns the full path of the configuration file, the name and the IP address of the machine that opened this project, the instance ID of the current project session, and the list of models belonging to this project. For each model, path, ID and state are returned.<br>If the allocated storage is too small for any of the arguments, none of the lists are returned, but the numProjects, numModels, maxProjectPathLen, maxModelPathLen, maxMachineNameLen and maxIpLen 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.</td></tr><tr><td><strong>Required Control</strong></td><td>None</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalGetActiveProjects</strong>(unsigned short allocatedProjects,unsigned short *numProjects, unsigned short allocatedModels, unsigned short *numModels,unsigned short allocatedProjectsPathLen, unsigned short *maxProjectPathLen, unsigned short allocatedModelPathLen, unsigned short *maxModelPathLen, unsigned short allocatedMachineNameLen, unsigned short *maxMachineNameLen, unsigned short allocatedIpLen,unsigned short *maxIpLen, char *projectPaths[], unsigned short instanceIDs[], char *machineNames[],char *controllerIPs[], char *modelPaths[],unsigned short numModelsPerProject[] unsigned short modelIDs[],unsigned short modelStates[]);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>allocatedProjects:</strong> number of projects for which storage was allocated by the caller for the paths, machine name, IP addresses and instance ids.</li><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>allocatedProjectPathLen:</strong> allocated length of storage to receive the project paths</li><li><strong>allocatedModelPathLen:</strong> allocated length of storage to receive the model paths</li><li><strong>allocatedMachineNameLen:</strong> allocated length of storage to receive the machine names</li><li><strong>allocatedIpLen:</strong> allocated length of storage to receive the IP addresses</li></ul></td></tr><tr><td><strong>Output</strong></td><td><ul><li><strong>numProjects pointer</strong> to where the API will store the actual number of active projects.</li><li><strong>numModels pointer</strong> to where the API will store the actual total number of models for all active projects.</li><li><strong>maxProjectPathLen pointer</strong> to where the API will store the length of the longest project path.</li><li><strong>maxModelPathLen pointer</strong> to where the API will store the length of the longest model path.</li><li><strong>maxMachineNameLen pointer</strong> to where the API will store the length of the longest machine name.</li><li><strong>maxIpLen pointer</strong> to where the API will store the length of the longest IP address.</li><li><strong>projectPaths array</strong> of strings where the API will store the paths of the active projects’ configuration files.</li><li><strong>instanceIDs array</strong> where the API will store the instance Ids of the active projects.</li><li><strong>machineNames array</strong> where the API will store the machine names.</li><li><strong>controllerIPs array</strong> where the API will store the IP addresses.</li><li><strong>modelPaths array</strong> where the API will store the model paths of all active projects.</li><li><strong>numModelsPerProject array</strong> where the API will store the number of models for each project. Use these values to determine what model belongs to what project.</li><li><strong>modelIDs array</strong> where the API will store the model IDs for all active projects.</li><li><strong>modelStates array</strong> where the API will store the model states for all active projects.</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>OP_COMMAND(OpenProject),OP_COMMAND (CloseProject), 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/opalgetactiveprojects.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.
