grandMA3 User Manual Publication

StrToHandle(string)

grandMA3 User Manual » Plugins » Lua Functions - Object-Free API » StrToHandle(string)
Version 2.1

Description

The object-free StrToHandle Lua function converts a string with a hexadecimal number format into a handle. The string needs to correlate with an actual handle.

See the Handle topic for more info regarding handles and links to other related functions.

Arguments

  • String:
    The string with a handle number in a hexadecimal format.

Return

  • Handle:
    The returned handle based on the string with a hexadecimal number.

Example

This example prints the handle hex number for the selected sequence. It also converts the string back to a handle and uses this to print the name of the sequence:

Lua
return function()
-- Store a variable with the string of the handle converted to hex
local mySeqStr = HandleToStr(SelectedSequence())
-- Print some feedback with the handle in a string version
Printf("The handle for the selected sequence (string version): %s", mySeqStr)
-- Print some feedback where the string is converted back to a handle
Printf("The name of the selected sequence is: %s", StrToHandle(mySeqStr).name)
end