IPropertyStoreFactory::GetPropertyStoreForKeys method (propsys.h)

Gets an IPropertyStore object, given a set of property keys. This provides an alternative, possibly faster, method of getting an IPropertyStore object compared to calling IPropertyStoreFactory::GetPropertyStore.

Syntax

HRESULT GetPropertyStoreForKeys(
  [in]  const PROPERTYKEY     *rgKeys,
  [in]  UINT                  cKeys,
  [in]  GETPROPERTYSTOREFLAGS flags,
  [in]  REFIID                riid,
  [out] void                  **ppv
);

Parameters

[in] rgKeys

Type: const PROPERTYKEY*

A pointer to an array of PROPERTYKEY structures.

[in] cKeys

Type: UINT

The number of PROPERTYKEY structures in the array pointed to by rgKeys.

[in] flags

Type: GETPROPERTYSTOREFLAGS

GETPROPERTYSTOREFLAGS values that modify the store that is returned.

[in] riid

Type: REFIID

A reference to IID of the object to create.

[out] ppv

Type: void**

When this method returns, contains the address of an IPropertyStore interface pointer.

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, which eliminates 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