IPrograms::get_ItemsByKey

Microsoft DirectX 8.1 (C++)

IPrograms::get_ItemsByKey

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The get_ItemsByKey method retrieves a sorted collection of objects that meet the specified criteria.

Syntax

HRESULT get_ItemsByKey(
  IMetaPropertyType*  pproptype,
  IGuideDataProvider*  pprovider,
  long  idLang,
  long  vt,
  IPrograms**  ppprogs
);

Parameters

pproptype

[in] Specifies the IMetaPropertyType interface of a MetaPropertyType object. Only objects containing a metaproperty of this type are retrieved.

pprovider

[in] Specifies the IGuideDataProvider interface of a GuideDataProvider object. Can be NULL. If not NULL, only objects associated with this data provider are retrieved.

idLang

[in] Specifies the language. If zero, objects associated with all languages are retrieved.

[in] Specifies the VARIANT type of the metaproperty. Only objects whose matching metaproperty is of this type are retrieved.

ppprogs

[out] Address of a variable to receive the IPrograms interface of the collection retrieved.

Return Values

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_INVALIDARG	vt is not a valid type.
E_OUTOFMEMORY	There is not sufficient memory to create the collection.
E_POINTER	Data cannot be read from or written to a supplied address.

Remarks

The retrieved collection is sorted by the metaproperty value. Use IPrograms::get_ItemWithKey to retrieve the first item whose key matches a particular value.

See Also