|
VolumeAutomation.PointRemove method |
  
|
|
VolumeAutomation.PointRemove method |
|
Remarks
Removes an existing volume point.
For details about using Volume Automation refer to the How to manage Volume Automation tutorial.
Syntax
[Visual Basic] Public Function PointRemove ( nPlayerIndex as Int16, strVolumePointName as String ) as enumErrorCodes |
[C#] public enumErrorCodes PointRemove ( Int16 nPlayerIndex, string strVolumePointName ); |
[C++] public: enumErrorCodes PointRemove ( Int16 nPlayerIndex, string strVolumePointName ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
||||||
strVolumePointName |
String representing the friendly name of the volume point to remove: this name must be identical to the corresponding one used for adding the volume point through the VolumeAutomation.PointAdd method. |
||||||
bEnable |
Boolean value that specifies if the volume point must be enabled or disabled. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
enumErrorCodes.NOERROR (0) |
The method call was successful |
Negative value |
An error occurred: see the LastError property for further error details or for a list of the possible error values. |
