simGetApiInfo

Returns the call tip (or info text) for an API function

C++ synopsis

char* simGetApiInfo(int scriptHandle, const char* apiWord)

Arguments

• scriptHandle: handle of the script. Can be -1 to be script agnostic
• apiWord: API functions or variable to retrieve the info for, e.g. "sim.getObject"

Return

• nullptr in case of an error. Otherwise the information related to the API function or variable. The user is in charge of releasing the returned buffer with simReleaseBuffer.