Regular API
function
simGetCollectionName
Description
Retrieves the name of a collection based on its handle. See also
simSetCollectionName
.
C synopsis
simChar* simGetCollectionName(simInt collectionHandle)
C parameters
collectionHandle
: handle of the collection
C return value
pointer to the name of the collection or NULL if an error occurred. The user is in charge of destroying the returned buffer with
simReleaseBuffer
Lua synopsis
string collectionName=simGetCollectionName(number collectionHandle)
Lua parameters
Same as C-function
Lua return values
Same as C-function (but nil instead of NULL, and
simReleaseBuffer
does not need to be called)
All regular API functions on one page