Regular API
function
simGetCollectionHandle (remote API equivalent:
simxGetCollectionHandle
)
Description
Retrieves a collection handle based on its name. The operation of this function depends on the current name suffix settings (see
simGetNameSuffix
,
simSetNameSuffix
, and the section on
accessing general-type objects
). See also
simCreateCollection
,
simAddObjectToCollection
,
simGetCollectionObjects
and
simIsHandleValid
.
C synopsis
simInt simGetCollectionHandle(const simChar* collectionName)
C parameters
collectionName
: name of the collection
C return value
Handle of the collection, or -1 in case of an error
Lua synopsis
number collectionHandle=simGetCollectionHandle(string collectionName)
Lua parameters
Same as C-function
Lua return values
Same as C-function
All regular API functions on one page