Edit

Share via

IPropertySystem::GetPropertyDescription method (propsys.h)

  • Article

Gets an instance of the subsystem object that implements IPropertyDescription, to obtain the property description for a given PROPERTYKEY.

Syntax

HRESULT GetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

Parameters

[in] propkey

Type: REFPROPERTYKEY

A reference to the desired property key. See PROPERTYKEY.

[in] riid

Type: REFIID

A reference to the desired IID.

[out] ppv

Type: void**

The address of an IPropertyDescription interface pointer.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Indicates the interface is obtained.
E_INVALIDARG
 Indicates that ppv is NULL.
TYPE_E_ELEMENTNOTFOUND
 Indicates that the PROPERTYKEY does not exist in the schema subsystem cache.

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 XP with SP2, Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 with SP1 [desktop apps only]
Target Platform Windows
Header propsys.h
DLL Propsys.dll (version 5.0 or later)
Redistributable Windows Desktop Search (WDS) 3.0

See also

IPropertySystem