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

# OpalWaitExecutable

<table data-header-hidden><thead><tr><th width="199.77783203125"></th><th></th></tr></thead><tbody><tr><td><strong>Group</strong></td><td>Utilities</td></tr><tr><td><strong>Description</strong></td><td>Waits for outputs generated by an executable. Call this function until the executable have finished (when status = 1).<br>When the executable was started with the option <strong>OP_EXEC_FILE_OUTPUT_STDERR</strong>setted the stdout and stderr buffer are output in two different buffer.</td></tr><tr><td><strong>Required Control</strong></td><td>None</td></tr><tr><td><strong>Usage</strong></td><td>int <strong>OpalWaitExecutable</strong>(int timeout,char * displayBuffer,unsigned int displayBufferSize, char * errorBuffer,unsigned int errorBufferSize, int * status);</td></tr><tr><td><strong>Input</strong></td><td><ul><li><strong>timeOut:</strong> Timeout in milliseconds to wait for results.</li><li><strong>displayBufferSize:</strong> Size of the allocated display buffer.</li><li><strong>errorBufferSize:</strong> Size of the allocated error buffer.</li></ul></td></tr><tr><td><strong>Output</strong></td><td><ul><li><strong>displayBuffer:</strong> Pointer where the API will store the stdout and stderr output of the executable. When the executable was started with <strong>OP_EXEC_FILE_OUTPUT_STDERR(2)</strong> option, this buffer also doesn’t contain the stderr outputs. Buffer must be allocated by the user.</li><li><strong>errorBuffer:</strong> Pointer where the API will store the stderr output of the executable when the executable was started with the <strong>OP_EXEC_FILE_OUTPUT_STDERR(2)</strong>. Otherwise the string is empty. Buffer must be allocated by the user.</li><li><strong>status:</strong> Status of the execution. True(1) when executable has finished, otherwise False(0).</li></ul></td></tr><tr><td><strong>Return value</strong></td><td><ul><li><strong>EOK:</strong> Success.</li><li><strong>OP_API_WAIT_EXEC_FILE:</strong> Error receiving results from the executable.</li></ul></td></tr><tr><td><strong>Examples</strong></td><td>None</td></tr><tr><td><strong>Related items</strong></td><td>OpalStartExecutable, OpalStopExecutable.</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/opalwaitexecutable.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.
