Classes > TracksBoard class > Methods > TracksBoard.ItemVolumePointFriendlyNameSet method

Remarks

Modifies the friendly name for a specific volume point previously added to the given sound item through the TracksBoard.ItemVolumePointAdd method. The friendly name can be obtained through the TracksBoard.ItemVolumePointFriendlyNameGet method.

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

nUniqueId as Int32,

nIndex as Int32,

strFriendlyName as String

) as enumErrorCodes

[C#]

public enumErrorCodes ItemVolumePointFriendlyNameSet (

Int32 nUniqueId,

Int32 nIndex,

string strFriendlyName

);

[C++]

public: enumErrorCodes ItemVolumePointFriendlyNameSet (

Int32 nUniqueId,

Int32 nIndex,

string strFriendlyName

);

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

Zero-based index of the volume point. The total number of available volume points can be obtained through the TracksBoard.ItemVolumePointCountGet method.

strFriendlyName

String containing the friendly name of the item

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.