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

# OpalGetSubsystemList

<table data-header-hidden><thead><tr><th width="199.77783203125"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Model Preparation</td></tr><tr><td><strong>Description</strong></td><td><p>Returns the list of subsystems in the current model: their name, their logical id and the name of the physical node on which each is assigned. The physical node name is an empty string when the subsystem has not yet been assigned to a physical node.</p><p><br>If the allocated storage is too small for the number of subsystems, or for the longest subsystem or physical node name, none of the names or logical ids are returned, but the <strong>numSubsys</strong>, <strong>maxSubsysNameLen</strong> and <strong>maxPhysNodeNameLen</strong> values are returned to the user. An application can use this fact to specify lengths of <strong>0</strong> 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>OpalGetSubsystemList</strong>(unsigned short allocatedSubsys,unsigned short *numSubsys,unsigned short allocatedSubsysNameLen, unsigned short *maxSubsysNameLen, unsigned short allocatedPhysNodeNameLen, unsigned short *maxPhysNodeNameLen, char *subsysName[],unsigned short logicalId[], char *physNodeName[]);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>allocatedSubsys:</strong> number of subsystems for which storage was allocatedby the caller for the names and logical Ids.</li><li><strong>allocatedSubsysNameLen:</strong> allocated length of the storage buffer to receive the subsystem names.</li><li><strong>allocatedPhysNodeNameLen:</strong> allocated length of the storage buffer to receive thephysical node names.</li></ul></td></tr><tr><td><strong>Output</strong></td><td><ul><li><strong>numSubsys:</strong> Number of subsystems.</li><li><strong>maxSubsysNameLen:</strong> Length of the longest subsystem name.</li><li><strong>maxPhysNodeNameLen:</strong> Length of the longest physical node name.</li><li><strong>subsysName:</strong> Array of strings where the API stores the names of the subsystems.</li><li><strong>logicalId:</strong> See <strong>Glossary</strong>.</li><li><strong>physicalNodeName:</strong> Array of strings where the API will store the names ofthe physical nodes associated to each subsystem.</li></ul></td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>E2BIG:</strong> Specified storage not big enough to receive values.</li><li><strong>EBADF:</strong> Model not specified by previous OpalConnect or OpalSetCurrentModel.</li><li><strong>ESRCH:</strong> Model has not been compiled yet.</li><li><strong>EIO:</strong> Error sending the request or receiving the reply.</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>See example <strong>configuration</strong>.</td></tr><tr><td><strong>Related items</strong></td><td>None</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/opalgetsubsystemlist.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.
