Copyright © 2001-2016 MultiMedia Soft

Effects.PhaserIsApplied method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if the phaser effect has been applied to the given player through the Effects.PhaserApply method.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

control.Effects.PhaserIsApplied (

nPlayer as Integer,

bApplied as enumBoolean

) as enumErrorCodes


 

[C++]

short control.Effects.PhaserIsApplied (

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 effect is currently applied.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE (default)

0

The effect has not been applied

BOOL_TRUE

1

The effect has been applied

 

 

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.