IMSVidCtl::get__InputsAvailable method (msvidctl.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__InputsAvailable method retrieves the input devices that are available in a specified category.

Syntax

HRESULT get__InputsAvailable(
  [in]  LPCGUID            CategoryGuid,
  [out] IMSVidInputDevices **pVal
);

Parameters

[in] CategoryGuid

Pointer to a GUID that specifies the category to enumerate. Supported categories include the following.

[out] pVal

Receives an IMSVidInputDevices interface pointer. The caller must release the interface.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

This method returns a read-only collection of input devices. Use the returned IMSVidInputDevices pointer to enumerate the collection.

Examples

The following example enumerates the available BDA-compatible tuners and retrieves their friendly names.

CComPtr<IMSVidInputDevices> pInputs;
hr = pVidControl->get__InputsAvailable(&KSCATEGORY_BDA_NETWORK_PROVIDER, &pInputs);
if (SUCCEEDED(hr))
{
    long lCount;
    hr = pInputs->get_Count(&lCount);
    for (long ix = 0; ix < lCount; ix++)
    {
        CComBSTR bstrName;
        CComVariant var(ix);
        CComPtr<IMSVidInputDevice> pInput;
        hr = pInputs->get_Item(var, &pInput);
        hr = pInput->get_Name(&bstrName);
        // Display the name.
    }
}

Requirements

See also

IMSVidCtl Interface

IMSVidCtl::get_InputActive