PSSetPropertyValue-Funktion (propsys.h)

Legt den Wert einer Eigenschaft in einem Eigenschaftenspeicher fest.

Syntax

PSSTDAPI PSSetPropertyValue(
  [in] IPropertyStore       *pps,
  [in] IPropertyDescription *ppd,
  [in] REFPROPVARIANT       propvar
);

Parameter

[in] pps

Typ: IPropertyStore*

Zeiger auf eine instance der IPropertyStore-Schnittstelle, die den Eigenschaftenspeicher darstellt, der die Eigenschaft enthält.

[in] ppd

Typ: IPropertyDescription*

Zeiger auf eine instance der IPropertyDescription-Schnittstelle, die die einzelne Eigenschaft identifiziert.

[in] propvar

Typ: REFPROPVARIANT

Verweis auf eine PROPVARIANT-Struktur , die den neuen Wert enthält.

Rückgabewert

Typ: HRESULT

Wenn diese Funktion erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Diese Hilfsfunktion wird verwendet, um einen Eigenschaftswert in einen Speicher zu schreiben. Wenn der aufrufende Code bereits über eine PROPERTYKEY-Struktur verfügt, ist es möglicherweise einfacher, IPropertyStore::SetValue direkt aufzurufen.

Beispiele

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

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

HRESULT hr = PSSetPropertyValue(pStore, pPropDesc, propvar);

if (SUCCEEDED(hr))
{
    // The value has been written to the store but has not been committed yet.
}

Anforderungen

Weitere Informationen

IPropertyStore::Commit

PSGetPropertyValue