Método IPropertyStore::SetValue (propsys.h)
Este método establece un valor de propiedad o reemplaza o quita un valor existente.
Sintaxis
HRESULT SetValue(
REFPROPERTYKEY key,
REFPROPVARIANT propvar
);
Parámetros
key
TBD
propvar
TBD
Valor devuelto
El IPropertyStore::SetValue método puede devolver cualquiera de los siguientes elementos:
| Código devuelto | Descripción |
|---|---|
|
El cambio de propiedad se realizó correctamente. |
|
El valor se estableció pero se trunca. |
|
Se trata de un código de error. El almacén de propiedades era de solo lectura, por lo que el método no pudo establecer el valor. |
Comentarios
IPropertyStore::SetValue afecta solo a la instancia del almacén de propiedades actual. Un controlador de propiedades implementa IPropertyStore::SetValue acumulando cambios de propiedad en una estructura de datos en memoria. Los cambios de propiedad se escriben en la secuencia solo cuando se llama a IPropertyStore::Commit .
Si se llama a IPropertyStore::Commit en un almacén de propiedades de solo lectura, el controlador de propiedades determina esto y devuelve STG_E_ACCESSDENIED.
Si se agregó o quitó un valor como resultado de SetValue, las enumeraciones posteriores de IPropertyStore::GetCount e IPropertyStore::GetAt reflejan ese cambio y las llamadas posteriores para IPropertyStore::SetValue reflejar el valor cambiado.
Agregar una nueva propiedad
Si el valor de propiedad al que apunta la clave no existe en el almacén, IPropertyStore::SetValue agrega el valor al almacén.
Reemplazar un valor de propiedad existente
Si el valor de propiedad al que apunta la clave ya existe en el almacén, el valor almacenado se reemplaza.
Quitar una propiedad existente
Para quitar un valor del almacén de propiedades, establezca el miembro vt de la estructura a la que apunta pv en VT_EMPTY. Si ese valor no está presente, no haga nada y el método devuelve S_OK.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Disponible con Windows Vista y versiones posteriores del sistema operativo Windows. |
| Plataforma de destino | Universal |
| Encabezado | propsys.h |
| Library | Propsys.idl |
| IRQL | Todos los niveles |