|
SoundComposer.ItemFriendlyNameSet method |
  
|
|
SoundComposer.ItemFriendlyNameSet method |
|
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 ( nPlayerIndex as Int16, nUniqueId as Int32, strFriendlyName as String ) as enumErrorCodes |
[C#] public enumErrorCodes ItemFriendlyNameSet ( Int16 nPlayerIndex, Int32 nUniqueId, string strFriendlyName ); |
[C++] public: enumErrorCodes ItemFriendlyNameSet ( Int16 nPlayerIndex, Int32 nUniqueId, string strFriendlyName ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player that owns the sound composer session |
nUniqueId |
The unique identifier of the element previously returned by the call to one of the following methods: - SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd for sound file 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. |
