COM Objects > TracksBoard object > 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 object section.

Syntax

[Visual Basic]

control.TracksBoard.ItemVolumePointFriendlyNameSet (

nUniqueId as Long,

nIndex as Long,

strFriendlyName as String

) as enumErrorCodes

[C++]

short control.TracksBoard.ItemVolumePointFriendlyNameSet (

long nUniqueId,

long nIndex,

LPCTSTR 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, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful