CaptureBuffer.GetEffectsStatus(Int32) Method (Microsoft.DirectX.DirectSound)

  • Article

Retrieves the status of capture effects.

Definition

Visual Basic Public Function GetEffectsStatus( _
    ByVal numEffects As Integer _
) As CaptureEffectsReturnValue()
C# public CaptureEffectsReturnValue[] GetEffectsStatus(
    int numEffects
);
C++ public:
array<CaptureEffectsReturnValue>^ GetEffectsStatus(
    int numEffects
);
JScript public function GetEffectsStatus(
    numEffects : int
) : CaptureEffectsReturnValue[];

Parameters

numEffects System.Int32
The number of capture effects to retrieve.

Return Value

Microsoft.DirectX.DirectSound.CaptureEffectsReturnValue[]
An array of values from the CaptureEffectsReturnValue enumeration that describe the status of capture effects in the CaptureBuffer object.

Remarks

Exceptions

ArgumentExceptionLeave Site

An invalid parameter was passed to the called method.