Funzione PSGetPropertyValue (propsys.h)

Articolo
03/05/2024

Ottiene un valore della proprietà da un archivio delle proprietà.

Sintassi

PSSTDAPI PSGetPropertyValue(
  [in]  IPropertyStore       *pps,
  [in]  IPropertyDescription *ppd,
  [out] PROPVARIANT          *ppropvar
);

Parametri

[in] pps

Tipo: IPropertyStore*

Puntatore a un'istanza dell'interfaccia IPropertyStore , che rappresenta l'archivio delle proprietà da cui ottenere il valore.

[in] ppd

Tipo: IPropertyDescription*

Puntatore a un'istanza dell'interfaccia IPropertyDescription , che rappresenta la proprietà nell'archivio delle proprietà.

[out] ppropvar

Tipo: PROPVARIANT*

Puntatore a una struttura PROPVARIANT non inizializzata. Quando questa funzione restituisce, punta al valore della proprietà richiesto.

Valore restituito

Tipo: HRESULT

Se questa funzione ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Questa funzione helper viene usata per leggere un valore di proprietà da un archivio. Se il codice chiamante ha già una struttura PROPERTYKEY , potrebbe essere più semplice chiamare direttamente IPropertyStore::GetValue .

Esempio

L'esempio seguente, da includere come parte di un programma più ampio, illustra come usare PSGetPropertyValue.

// IPropertyDescription *pPropDesc;
// IPropertyStore *pStore;
// Assume the variables pPropDesc and pStore are initialized and valid.
PROPVARIANT propvar;

HRESULT hr = PSGetPropertyValue(pStore, pPropDesc, &propvar);

if (SUCCEEDED(hr))
{
    // propvar is valid.
 
    PropVariantClear(&propvar);
}

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP con SP2, Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2003 con SP1 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	propsys.h
Libreria	Propsys.lib
DLL	Propsys.dll (versione 6.0 o successiva)
Componente ridistribuibile	Windows Desktop Search (WDS) 3.0

Vedi anche

PSSetPropertyValue

Condividi tramite