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

# OpalDisplayInformation

<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>Gets the compilation or execution messages as well as return the compilation or execution status. You must call <strong>OpalRegisterDisplay</strong> before calling this function to indicate to the controller to send messages to the client.</td></tr><tr><td><strong>Required Control</strong></td><td>None</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalDisplayInformation</strong>(char *results,unsigned short bufLen, int timeout,unsigned short *done, unsigned short *displayId);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>bufLen:</strong> Available buffer size in bytes (provided by the caller). Minimum recommended size is 512 bytes.</li><li><strong>timeout:</strong> Milliseconds to wait for available results. 0 = do not wait.OP_API_INFINITE = block for available results.</li></ul></td></tr><tr><td><strong>Output</strong></td><td><ul><li><strong>done:</strong> Status of the compilation or the execution. Return <strong>True</strong> if the compilation has completed or execution has been reset.</li><li><p><strong>displayId:</strong> Message’s source</p><ul><li>0: compilation</li><li>1: Master subsystem</li><li>2+: Slave subsystems</li></ul></li><li><strong>results:</strong> Buffer supplied by the caller where the API stores the available messages. Can be NULL if results are not desired. Compilation or execution messages are a C string (terminated by a '\0').</li></ul></td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>EAGAIN:</strong> No more information to display.</li><li><strong>OP_API_ESEPARATION:</strong> Error while separating the model's subsystems.</li><li><strong>OP_API_ECODE_GENERATION:</strong> Error while generating code for the subsystems.</li><li><strong>EPERM:</strong> System control had not been granted to this client.</li><li><strong>EBUSY:</strong> Model executables already loaded.</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>OP_API_ENO_PRODUCT:</strong> No license for RT-LAB and RT-LABx.</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>See example <strong>compilation</strong>.</td></tr><tr><td><strong>Related items</strong></td><td>OpalRegisterDisplay</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/opaldisplayinformation.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.
