RemoteTurnkeyGetByteArray is an OCL operator for developers who need to obtain a byte-array value from a remote Turnkey session.
Purpose
Use RemoteTurnkeyGetByteArray when a remote Turnkey interaction needs to return binary data rather than a string value. Binary data is data represented as bytes, for example a file payload or other non-text value.
The available documentation does not yet define the operator's call signature, required arguments, return type representation, error behavior, or how it identifies the remote session. Do not infer these details from similarly named operators.
Before you use it
A remote Turnkey operation normally forms part of a session-based sequence. Review the related RemoteTurnkey operators to understand the surrounding workflow:
- Use RemoteTurnkeyExecuteAction to execute an action in the remote session.
- Use
RemoteTurnkeyGetByteArrayto retrieve the binary result when the remote action produces binary data. - Use RemoteTurnkeyGetStringValue when the expected result is text instead of binary data.
- Use RemoteTurnkeyCloseSession to close the remote session when the interaction is complete.
Choosing a result operator
| Expected result from the remote Turnkey action | Operator to use |
|---|---|
| Text value, such as a status message or identifier | RemoteTurnkeyGetStringValue |
| Binary value, such as a byte-array payload | RemoteTurnkeyGetByteArray
|
Example workflow
The following is a conceptual sequence, not executable OCL syntax. Replace each step with the documented call syntax when it is available.
- Execute a remote action that produces binary data.
- Retrieve that data with
RemoteTurnkeyGetByteArray. - Process or store the returned bytes according to the receiving model and application requirements.
- Close the remote session with RemoteTurnkeyCloseSession.
Limitations
This page intentionally does not include a code sample. The authoritative documentation currently does not specify:
- the arguments accepted by
RemoteTurnkeyGetByteArray; - whether the operator is invoked on
selfVM, another object, or a session object; - the exact byte-array type returned to OCL;
- how missing values, remote errors, or invalid sessions are reported; or
- size limits, encoding requirements, or persistence guidance for the returned data.
