Método IPropertyStore::SetValue (propsys.h)
Esse método define um valor de propriedade ou substitui ou remove um valor existente.
Sintaxe
HRESULT SetValue(
REFPROPERTYKEY key,
REFPROPVARIANT propvar
);
Parâmetros
key
TBD
propvar
TBD
Retornar valor
O IPropertyStore::SetValue método pode retornar qualquer um dos seguintes:
| Código de retorno | Descrição |
|---|---|
|
A alteração de propriedade foi bem-sucedida. |
|
O valor foi definido, mas truncado. |
|
Este é um código de erro. O repositório de propriedades era somente leitura para que o método não pudesse definir o valor. |
Comentários
IPropertyStore::SetValue afeta apenas a instância do repositório de propriedades atual. Um manipulador de propriedades implementa IPropertyStore::SetValue acumulando alterações de propriedade em uma estrutura de dados na memória. As alterações de propriedade são gravadas no fluxo somente quando IPropertyStore::Commit é chamado.
Se IPropertyStore::Commit for chamado em um repositório de propriedades somente leitura, o manipulador de propriedades determinará isso e retornará STG_E_ACCESSDENIED.
Se um valor foi adicionado ou removido como resultado de SetValue, enumerações subsequentes por IPropertyStore::GetCount e IPropertyStore::GetAt refletem essa alteração e chamadas subsequentes para IPropertyStore::SetValue refletir o valor alterado.
Adicionando uma nova propriedade
Se o valor da propriedade apontado por chave não existir no repositório, IPropertyStore::SetValue adicionará o valor ao repositório.
Substituindo um valor de propriedade existente
Se o valor da propriedade apontado por chave já existir no repositório, o valor armazenado será substituído.
Removendo uma propriedade existente
Para remover um valor do repositório de propriedades, defina o membro vt da estrutura apontada por pv como VT_EMPTY. Se esse valor não estiver presente, não faça nada e o método retornará S_OK.
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Disponível com o Windows Vista e versões posteriores do sistema operacional Windows. |
| Plataforma de Destino | Universal |
| Cabeçalho | propsys.h |
| Biblioteca | Propsys.idl |
| IRQL | Todos os níveis |