|
Effects.FilterIsApplied method |
  
|
|
Effects.FilterIsApplied method |
|
Remarks
Verifies if a filter has been applied to the given player through the Effects.FilterApply method.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] control.Effects.FilterIsApplied ( nPlayer as Integer, bApplied as enumBoolean ) as enumErrorCodes |
[C++] short control.Effects.FilterIsApplied ( short nPlayer, long *bApplied ); |
Parameter |
Description |
|||||||||
|
|
|||||||||
nPlayer |
Number representing the zero-based index of the involved player |
|||||||||
bApplied |
Reference that, on return from the method call, will contain the boolean value specifying if the filter is currently applied. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.ERR_NOERROR (0) |
The call was successful. |
