IPropertyDescriptionList::GetAt method (propsys.h)

Article
02/22/2024

Gets the property description at the specified index in a property description list.

Syntax

HRESULT GetAt(
  [in]  UINT   iElem,
  [in]  REFIID riid,
  [out] void   **ppv
);

Parameters

[in] iElem

Type: UINT

The number of the property in the list string.

[in] riid

Type: REFIID

A reference to the IID of the requested property description interface, typically IID_IPropertyDescription.

[out] ppv

Type: void**

When this method returns, contains the interface pointer requested in riid. Typically, this is IPropertyDescription.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

It is recommended that you use the IID_PPV_ARGS macro, defined in objbase.h, to package the riid and ppv parameters. This macro provides the correct IID based on the interface pointed to by the value in ppv, eliminating the possibility of a coding error.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	propsys.h

Share via