Regular API function

simGetApiInfo / sim.getApiInfo

Description Returns the call tip (or info text) for an API function or variable. See also sim.getApiFunc.
C/C++
synopsis
simChar* simGetApiInfo(simInt scriptHandleOrType,const simChar* apiWord)
C/C++
parameters
scriptHandleOrType: the handle of the script, otherwise the type of the script. Can be -1 in order to ignore the script type.
apiWord: the API functions or variable to retrieve the info for, e.g. "sim.getObject"
C/C++
return value
nullptr in case of an error, or if there is no information. Otherwise the information related to the API function or variable. The user is in charge of releasing the returned buffer with simReleaseBuffer.
Lua synopsis string info=sim.getApiInfo(int scriptHandleOrType,string apiWord)
Lua parameters
Similar to the C-function counterpart
Lua return values
Similar to the C-function counterpart
Python synopsis string info=sim.getApiInfo(int scriptHandleOrType,string apiWord)