Regular API function

simGetObjectAlias / sim.getObjectAlias

Description Retrieves the alias or path of an object based on its handle. See also sim.setObjectAlias.
C/C++
synopsis
simChar* simGetObjectAlias(simInt objectHandle,simInt options)
C/C++
parameters
objectHandle: handle of the object.
options: alias formatting options: -1: naked alias (e.g. "Alias"), 0: ordered alias (e.g. "Alias[0]"), 1: short path that fully identifies the object (e.g. "/parentA/Alias[0]"), 2: full path (e.g. "/parentA/parentB/Alias[0]"), 3: naked alias with handle, if the alias is not unique (e.g. "Alias" or "Alias__42__"), 4: naked alias with handle (e.g. "Alias__42__"), 5: print version of the short path, which is not guaranteed to be unique (e.g. "/parentA/ ... /Alias[0]")
C/C++
return value
Alias or path of the object if operation was successful, nullptr otherwise. The user is in charge of destroying the returned buffer with simReleaseBuffer
Lua synopsis string alias=sim.getObjectAlias(int objectHandle,int options=-1)
Lua parameters
Similar to the C-function counterpart
Lua return values
Similar to the C-function counterpart
Python synopsis string alias=sim.getObjectAlias(int objectHandle,int options=-1)