IMediaParams::GetParam

The GetParam method retrieves the current value of the specified parameter. If the parameter is currently within an envelope segment, the returned value is the value on the most recently processed sample.

Syntax

HRESULT GetParam(
    DWORD dwParamIndex,
    MP_DATA *pValue
);

Parameters

dwParamIndex

[in] Zero-based index of the parameter.

pValue

[out] Pointer to a variable of type MP_DATA that receives the parameter value.

Return Values

Returns an HRESULT value. Possible values include the following.

Return Code Description
E_INVALIDARG Index out of range.
E_POINTER NULL pointer argument.
S_OK Success.

Remarks

To enumerate the parameters supported by this object, along with their index values, use the IMediaParamInfo interface.

Requirements

  Header: Medparam.h
  Library: Dmoguids.lib.

See Also

© 2004 Microsoft Corporation. All rights reserved.