Método IPerPropertyBrowsing::GetPredefinedValue (ocidl.h)

Recupera o valor da propriedade especificada associada a um nome de cadeia de caracteres predefinido. Essa propriedade está associada a um nome de cadeia de caracteres predefinido, conforme retornado de IPerPropertyBrowsing::GetPredefinedStrings. A cadeia de caracteres predefinida é identificada por um token retornado de GetPredefinedStrings.

Sintaxe

HRESULT GetPredefinedValue(
  [in]  DISPID  dispID,
  [in]  DWORD   dwCookie,
  [out] VARIANT *pVarOut
);

Parâmetros

[in] dispID

O identificador de expedição da propriedade para a qual um valor predefinido é solicitado.

[in] dwCookie

Um token que identifica qual valor retornar. O token foi retornado anteriormente na matriz pCaCookiesOut preenchida por GetPredefinedStrings.

[out] pVarOut

Um ponteiro para o valor VARIANT da propriedade .

Retornar valor

Esse método pode retornar os valores de retorno padrão E_INVALIDARG, E_OUTOFMEMORY e E_UNEXPECTED, bem como os valores a seguir.

Código de retorno	Descrição
S_OK	O método foi concluído com sucesso.
E_NOTIMPL	Esse objeto não dá suporte a cadeias de caracteres predefinidas ou valores predefinidos.
E_POINTER	O endereço no pVarOut não é válido. Por exemplo, pode ser NULL.

Comentários

Anotações para chamadores

O chamador é responsável por liberar todas as alocações contidas na VARIANT. A menos que o membro vt do VARIANT seja VT_VARIANT, o chamador pode liberar memória usando uma única chamada para VariantClear. Caso contrário, o chamador deve liberar recursivamente os valores VARIANT contidos antes de liberar a VARIANT externa.

Anotações aos implementadores

O suporte para nomes e valores predefinidos não é necessário. Se o objeto não der suporte a esses nomes, retorne E_NOTIMPL desse método. Se esse método não for implementado, IPerPropertyBrowsing::GetPredefinedStrings também não deverá ser implementado.

Esse método aloca qualquer memória necessária dentro da VARIANT.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	ocidl.h

Confira também

IPerPropertyBrowsing