PSGetPropertyDescriptionListFromString-Funktion (propsys.h)

Artikel
03/01/2024

Ruft eine instance einer Eigenschaftenbeschreibungslistenschnittstelle für eine angegebene Eigenschaftenliste ab.

Syntax

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

Parameter

[in] pszPropList

Typ: LPCWSTR

Zeiger auf eine Unicode-Zeichenfolge mit NULL-Beendigung, die die Eigenschaftenliste identifiziert. Weitere Informationen zum Format dieses Parameters finden Sie unter IPropertySystem::GetPropertyDescriptionListFromString .

[in] riid

Typ: REFIID

Verweis auf die Schnittstellen-ID der angeforderten Schnittstelle.

[out] ppv

Typ: void**

Wenn diese Funktion zurückgibt, enthält den in riid angeforderten Schnittstellenzeiger. Dies ist in der Regel IPropertyDescriptionList.

Rückgabewert

Typ: PSSTDAPI

Gibt einen der folgenden Werte zurück.

Rückgabecode	BESCHREIBUNG
S_OK	Die Schnittstelle wurde abgerufen.
E_INVALIDARG	Der ppv-Parameter ist NULL.

Hinweise

Diese Funktion ruft die Implementierung des Eigenschaftssubsystems von IPropertySystem::GetPropertyDescriptionListFromString auf, um eine Auflistung von Eigenschaften abzurufen, die als semikolonstrennte Eigenschaftenlistenzeichenfolge bereitgestellt werden.

Es wird empfohlen, das makro IID_PPV_ARGS zu verwenden, das in Objbase.h definiert ist, um die Parameter riid und ppv zu packen. Dieses Makro stellt die richtige IID basierend auf der Schnittstelle bereit, auf die der Wert in ppv verweist, wodurch die Möglichkeit eines Codierungsfehlers ausgeschlossen wird.

Weitere Informationen zu Eigenschaftenschemas finden Sie unter Eigenschaftenschemas.

Beispiele

Im folgenden Beispiel, das als Teil eines größeren Programms eingeschlossen werden soll, wird die Verwendung von PSGetPropertyDescriptionListFromString veranschaulicht.

IPropertyDescriptionList *pList;

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP mit SP2, Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 mit SP1 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	propsys.h
Bibliothek	Propsys.lib
DLL	Propsys.dll (Version 5.0 oder höher)
Verteilbare Komponente	Windows Desktop Search (WDS) 3.0

Freigeben über