CaptureBuffer.GetObjectInPath(Guid,Int32,Guid) Method (Microsoft.DirectX.DirectSound)
Retrieves a capture effect object associated with the CaptureBuffer object.
Definition
Visual Basic Public Function GetObjectInPath( _
ByVal guidObject As Guid, _
ByVal index As Integer, _
ByVal guidInterface As Guid
) As ObjectC# public object GetObjectInPath(
Guid
int index,
Guid
);C++ public:
Object
Guid
int index,
Guid
);JScript public function GetObjectInPath(
guidObject : Guid
index : int,
guidInterface : Guid
) : Object
Parameters
guidObject System.Guid
Unique class identifier of the object being searched for, such as DSoundHelper.CaptureEffectsMsAcousticEchoCancellation.index System.Int32
Index of the capture effect to retrieve from the CaptureBuffer object.guidInterface System.Guid
Unique identifier of the desired interface, such as DSoundHelper.InterfaceCaptureEffectsAcousticEchoCancellation.
Return Value
System.Object
A capture effect used by the CaptureBuffer object.
Remarks
The value in index is the index of the object within the array of effects in the CaptureBufferDescription structure used in the CaptureBuffer constructor.
An object is returned solely on the basis of whether it matches guidObject and index. It is up to the application to ensure that guidInterface specifies an interface that can be expected to be found on the object.
Since this method returns the type of Object
Exceptions
An invalid parameter was passed to the called method.
The buffer control (volume, pan, and so on) requested by the caller is not available. Controls must be specified when the buffer is created.
The requested object was not found.
Root exception type for all Microsoft DirectSound Exceptions. Derives from DirectXException.