Classes > TracksBoard class > Methods > TracksBoard.ItemVolumePointSelectedGet method

Remarks

Obtains the index of the selected volume point, if any.

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 ItemVolumePointSelectedGet (

nUniqueId as Int32,

ByRef nIndex as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumePointSelectedGet (

Int32 nUniqueId,

ref Int32 nIndex

);

[C++]

public: enumErrorCodes ItemVolumePointSelectedGet (

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, on return from the method call, will contain the zero-based index of the volume point. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.