setKey

format

boolean setKey(long key)

description

Sets the MediaObject's index key. This key uniquely identifies the MediaObject within the MediaCollection, and thus any MediaObject can be uniquely identified within an eVe system by referring to its key and the key of the MediaCollection in which it is stored.

parameters

key - the MediaObject's unique index key

returns

TRUE - if the key was successfully assigned

FALSE - if the key was not assigned

throws

The setKey() method does not throw any exceptions.