Copyright © 2008-2018 MultiMedia Soft

SoundComposer.ItemFriendlyNameGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the friendly name for a specific item. The friendly name can be modified through the SoundComposer.ItemFriendlyNameSet method.

 

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function ItemFriendlyNameGet (

nUniqueId as Int32

) as String


 

[C#]

public string ItemFriendlyNameGet (

Int32 nUniqueId

);


 

[C++]

public: string ItemFriendlyNameGet (

Int32 nUniqueId

);


 

Parameter

Description

 

 

nUniqueId

The unique identifier of the element previously returned by the call to one of the following methods:

- SoundComposer.ItemDtmfStringAdd for DTMF items.

- SoundComposer.ItemNoiseAdd for noise tone items.

- SoundComposer.ItemSlidingWaveToneAdd for sliding wave tone items.

- SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd, SoundComposer.ItemSoundFileFromEditorAdd,and SoundComposer.ItemSoundFileFromRecorderAdd for sound file items

- SoundComposer.ItemWaveToneAdd for wave tone items.

- SoundComposer.ItemSpeechFromStringAdd and SoundComposer.ItemSpeechFromFileAdd for text to speech items.

 

 

Return value

 

Value

Meaning

 

 

Empty string

The information is not available or an error occurred (see the LastError property for further error details)

Valid string

String containing the friendly name of the item