Box Connector 12.13

# get-locals

Displays the name, type, and value for all of the variables in the local scope of the current function.

NOTE: This command only displays variables that have standard Lua data types. Any C data types, such as the document object, are not listed. To see the value of a field in the document object, create a Lua variable to hold the value.

NOTE: You can only use this command when Lua execution is paused, for example by a breakpoint or as a result of the `break` command. To set a breakpoint, use the `set-breakpoint` command.

`/action=luaDebug&command=get-locals[&session=SessionID]`

Type: Synchronous

## Parameters

Parameter Name | Description | Required
--- | --- | ---
`Session` | To return the variables for a single session, instead of every session, set this parameter to the session ID. You can retrieve a session ID by using the get-status command. | No
`Include-metatables` | To display metatables for the variables that are listed, set this parameter to `true`. | No

## Example

`http://localhost:7000/action=luadebug&command=get-locals`

## Response

    <autnresponse xmlns:autn="http://schemas.autonomy.com/aci/">
      <action>LUADEBUG</action>
      <response>SUCCESS</response>
      <responsedata>
        <data>
          <command>get-locals</command>
          <session id="1e37b4cfbbcf580e1918f5d7bed36651">
            <locals>
              <local name="side1" type="number">3</local>
              <local name="side2" type="number">4</local>
              <local name="hypotenuse" type="number">5</local>
            </locals>
          </session>
        </data>
      </responsedata>
    </autnresponse>

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Box Connector 12.13

Topic Title: get-locals