Copyright © 2011-2018 MultiMedia Soft

SoundComposer.ItemFriendlyNameSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the friendly name for a specific item. The current friendly name can be obtained through the SoundComposer.ItemFriendlyNameGet 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 ItemFriendlyNameSet (

nUniqueId as Int32,

strFriendlyName as String

) as enumErrorCodes


 

[C#]

public enumErrorCodes ItemFriendlyNameSet (

Int32 nUniqueId,

string strFriendlyName

);


 

[C++]

public: enumErrorCodes ItemFriendlyNameSet (

Int32 nUniqueId,

string strFriendlyName

);


 

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.

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.