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 synopsis simChar* simGetApiInfo(simInt scriptHandleOrType,const simChar* apiWord)
C parameters
scriptHandleOrType: the handle of the script, otherwise the type of the script.
apiWord: the API functions or variable to retrieve the info for, e.g. "sim.getObjectHandle"
C return value
NULL 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(number scriptHandleOrType,string apiWord)
Lua parameters
Similar to the C-function
Lua return values
Similar to the C-function

All regular API functions on one page