IComponent::get_Status Method

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

Syntax

HRESULT get_Status(
  [out]  ComponentStatus *pStatus
);

Parameters

• pStatus [out]
  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

See Also

IComponent Interface

Send comments about this topic to Microsoft

Build date: 12/4/2008