Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IPropertySystem::GetPropertyDescription method

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

propkey [in]

Type: REFPROPERTYKEY

A reference to the desired property key. See PROPERTYKEY.

riid [in]

Type: REFIID

A reference to the desired IID.

ppv [out]

Type: void**

The address of an IPropertyDescription interface pointer.

Return value

Type: HRESULT

Returns one of the following values.

Return codeDescription
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

Minimum supported client

Windows XP with SP2, Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 with SP1 [desktop apps only]

Redistributable

Windows Desktop Search (WDS) 3.0

Header

Propsys.h

IDL

Propsys.idl

DLL

Propsys.dll (version 5.0 or later)

See also

IPropertySystem

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.