Description

The GetDisplayByIndex Lua function returns a handle to the display object matching the provided index number.

Arguments

Integer:
This function needs an index number for one of the displays.

Return

Handle:
The returned handle to the display object.

Example

This example prints the data connected to the handle. It uses the Dump() function:

Dump()

The Dump() function returns a string with information about the object, for instance, the name, class, path of the object, its properties, and children.

Learn more in the Dump() topic.

Copy Code

Lua

return function()
    -- Get the index number for "Display 1"
    local displayIndex = GetDisplayCollect()["Display 1"].INDEX
    -- return error text in case the index number is nil
    if displayIndex == nil then
        ErrPrintf('Something went wrong. It appears that there is no "display 1"')
        return
    end
    -- Dump all information about the display with the index number
    Printf("=============== START OF DUMP ===============")
    GetDisplayByIndex(displayIndex):Dump()
    Printf("================ END OF DUMP ================")
end

	Hint:
	The example uses the GetDisplayCollect() function to get the index number. The displays are children of the Display Collect, and this function can be used to access the same information using: GetDisplayCollect() The GetDisplayCollect Lua function returns a handle to the DisplayCollect object. Learn more in the GetDisplayCollect() topic. GetDisplayCollect()["Display 1"]