VolumeAutomation.PointGetName method |
|
Remarks
Gets the friendly name of a volume point.
For details about using Volume Automation refer to the How to manage Volume Automation tutorial.
Syntax
[Visual Basic] Public Function PointGetName ( nPlayerIndex as Int16, nIndex as Int16 ) as String |
[C#] public string PointGetName ( Int16 nPlayerIndex, Int16 nIndex ); |
[C++] public: string PointGetName ( Int16 nPlayerIndex, Int16 nIndex ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the involved player |
nIndex |
Number representing the zero-based index of the volume point |
Return value
Value |
Meaning |
|
|
Valid string |
String representing the friendly name of the volume point: this name is the same used for adding the volume point through the VolumeAutomation.PointAdd method. |
Empty string |
An error occurred, check the LastError property value in order to see the error code meaning file |