Función PSGetPropertyDescription (propsys.h)

Obtiene una instancia de una interfaz de descripción de propiedad para una propiedad especificada por una estructura PROPERTYKEY .

Sintaxis

PSSTDAPI PSGetPropertyDescription(
  [in]  REFPROPERTYKEY propkey,
  [in]  REFIID         riid,
  [out] void           **ppv
);

Parámetros

[in] propkey

Tipo: REFPROPERTYKEY

Referencia a propertykey.

[in] riid

Tipo: REFIID

Referencia al identificador de interfaz de la interfaz solicitada.

[out] ppv

Tipo: void**

Cuando se devuelve esta función, contiene el puntero de interfaz solicitado en riid. Suele ser IPropertyDescription, IPropertyDescriptionAliasInfo o IPropertyDescriptionSearchInfo.

Valor devuelto

Tipo: PSSTDAPI

Devuelve uno de los valores siguientes.

Código devuelto	Descripción
S_OK	Se obtuvo la interfaz .
E_INVALIDARG	El parámetro ppv es NULL.
TYPE_E_ELEMENTNOTFOUND	PROPERTYKEY no existe en la memoria caché del subsistema de esquema.

Comentarios

Se recomienda usar la macro IID_PPV_ARGS , definida en Objbase.h, para empaquetar los parámetros riid y ppv . Esta macro proporciona el IID correcto basado en la interfaz a la que apunta el valor de ppv, lo que elimina la posibilidad de un error de codificación.

Ejemplos

En el ejemplo siguiente, para incluirse como parte de un programa más grande, se muestra cómo usar PSGetPropertyDescription para obtener la descripción de la propiedad ratings.

IPropertyDescription *pPropDesc;

HRESULT hr = PSGetPropertyDescription(PKEY_Ratings, IID_PPV_ARGS(&pPropDesc));

if (SUCCEEDED(hr))
{
    // pPropDesc is now valid.
 
    pPropDesc->Release();
}

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP con SP2, Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 con SP1 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	propsys.h
Library	Propsys.lib
Archivo DLL	Propsys.dll (versión 6.0 o posterior)
Redistribuible	Windows Desktop Search (WDS) 3.0

Consulte también

PSGetPropertyDescriptionByName

PSGetPropertySystem