PSGetPropertyDescriptionListFromString function (propsys.h)

Article
02/22/2024

Gets an instance of a property description list interface for a specified property list.

Syntax

PSSTDAPI PSGetPropertyDescriptionListFromString(
  [in]  LPCWSTR pszPropList,
  [in]  REFIID  riid,
  [out] void    **ppv
);

Parameters

[in] pszPropList

Type: LPCWSTR

Pointer to a null-terminated, Unicode string that identifies the property list. See IPropertySystem::GetPropertyDescriptionListFromString for more information about the format of this parameter.

[in] riid

Type: REFIID

Reference to the interface ID of the requested interface.

[out] ppv

Type: void**

When this function returns, contains the interface pointer requested in riid. This is typically IPropertyDescriptionList.

Return value

Type: PSSTDAPI

Returns one of the following values.

Return code	Description
S_OK	The interface was obtained.
E_INVALIDARG	The ppv parameter is NULL.

Remarks

This function calls the property subsystem implementation of IPropertySystem::GetPropertyDescriptionListFromString to obtain a collection of properties provided as a semicolon-delimited property list string.

We recommend 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.

For more information about property schemas, see Property Schemas.

Examples

The following example, to be included as part of a larger program, demonstrates how to use PSGetPropertyDescriptionListFromString.

IPropertyDescriptionList *pList;

HRESULT hr = PSGetPropertyDescriptionListFromString(L"prop:System.Title;System.Size",
                                                    IID_PPV_ARGS(&pList));
                                                    
if (SUCCEEDED(hr))
{
    // pList is now valid.
 
    pList->Release();
}

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
Library	Propsys.lib
DLL	Propsys.dll (version 5.0 or later)
Redistributable	Windows Desktop Search (WDS) 3.0

Share via