Share via


IPropertyStore::SetValue-Methode (propsys.h)

Diese Methode legt einen Eigenschaftswert fest oder ersetzt oder entfernt einen vorhandenen Wert.

Syntax

HRESULT SetValue(
  REFPROPERTYKEY key,
  REFPROPVARIANT propvar
);

Parameter

key

TBD

propvar

TBD

Rückgabewert

Die IPropertyStore::SetValue -Methode kann eine der folgenden Elemente zurückgeben:

Rückgabecode BESCHREIBUNG
S_OK
Die Eigenschaftsänderung war erfolgreich.
INPLACE_S_TRUNCATED
Der Wert wurde festgelegt, aber abgeschnitten.
STG_E_ACCESSDENIED
Dies ist ein Fehlercode. Der Eigenschaftenspeicher war schreibgeschützt, sodass die Methode den Wert nicht festlegen konnte.

Hinweise

IPropertyStore::SetValueWirkt sich nur auf den aktuellen Eigenschaftenspeicher instance aus. Ein Eigenschaftenhandler implementiert, indem Eigenschaftsänderungen IPropertyStore::SetValue in einer In-Memory-Datenstruktur gesammelt werden. Eigenschaftenänderungen werden nur in den Stream geschrieben, wenn IPropertyStore::Commit aufgerufen wird.

Wenn IPropertyStore::Commit in einem schreibgeschützten Eigenschaftenspeicher aufgerufen wird, bestimmt der Eigenschaftenhandler dies und gibt STG_E_ACCESSDENIED zurück.

Wenn ein Wert als Ergebnis von SetValuehinzugefügt oder entfernt wurde, spiegeln nachfolgende Enumerationen von IPropertyStore::GetCount und IPropertyStore::GetAt diese Änderung und nachfolgende Aufrufe wider, um den geänderten Wert widerzuspiegeln IPropertyStore::SetValue .

Hinzufügen einer neuen Eigenschaft

Wenn der Eigenschaftswert, auf den vom Schlüssel verwiesen wurde, im Speicher nicht vorhanden ist, IPropertyStore::SetValue fügt den Wert dem Speicher hinzu.

Ersetzen eines vorhandenen Eigenschaftswerts

Wenn der Eigenschaftswert, auf den durch schlüssel verwiesen wurde, bereits im Speicher vorhanden ist, wird der gespeicherte Wert ersetzt.

Entfernen einer vorhandenen Eigenschaft

Um einen Wert aus dem Eigenschaftenspeicher zu entfernen, legen Sie das vt-Element der Struktur, auf das von pv verwiesen wird, auf VT_EMPTY fest. Wenn dieser Wert nicht vorhanden ist, tun Sie nichts, und die Methode gibt S_OK zurück.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Verfügbar mit Windows Vista und höheren Versionen des Windows-Betriebssystems.
Zielplattform Universell
Header propsys.h
Bibliothek Propsys.idl
IRQL Alle Ebenen

Weitere Informationen

Ipropertystore

IPropertyStore::Commit

IPropertyStore::GetAt

IPropertyStore::GetCount