Classes > TracksBoard class > Methods > TracksBoard.ItemIndexGet method

Remarks

Obtains the zero-based index of a sound item within the list of items added to the TracksBoard session.

Sound items are added to a list whose sorting is implemented by keeping count of the offset respect to the beginning of the TracksBoard session and, in case the offset of two items should be identical, by keeping count of the zero-based index of the track hosting the item.

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

Syntax

[Visual Basic]

Public Function ItemIndexGet (

nUniqueId as Int32,

ByRef nIndex as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemIndexGet (

Int32 nUniqueId,

ref Int32 nIndex

);

[C++]

public: enumErrorCodes ItemIndexGet (

Int32 nUniqueId,

Int32 __gc *nIndex

);

Parameter

Description

nUniqueId

Unique identification number assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing item has been cloned

nIndex

Reference that, after returning from the method call, will contain the the zero-based index of the item.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful