Share via


IComponent::get_Status method (tuner.h)

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

The get_Status method retrieves the requested or actual status of the component.

Syntax

HRESULT get_Status(
  [out] ComponentStatus *Status
);

Parameters

[out] Status

Pointer to a ComponentStatus enumeration that receives the status value.

Return value

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

When the TIF adds a component to the IComponents collection, it can indicate whether the component is active or not. An application can attempt to set this status, and resubmit a tune request. The tuner will update the status from the enumeration: Active, Inactive, Unavailable. The Unavailable status is only set by a tuner in response to a request to activate, when the component is not really available.

Requirements

Requirement Value
Minimum supported client Windows�XP [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header tuner.h

See also

IComponent Interface