Método IPropertyBag::Read (oaidl.h)

Lê a propriedade nomeada em uma VARIANT inicializada pelo chamador.

Sintaxe

HRESULT Read(
  LPCOLESTR pszPropName,
  VARIANT   *pVar,
  IErrorLog *pErrorLog
);

Parâmetros

pszPropName

O endereço do nome da propriedade a ser lida. Não pode ser NULL.

pVar

O endereço do VARIANT inicializado pelo chamador que recebe o valor da propriedade na saída. A função define o campo de tipo e o campo de valor na VARIANT antes de retornar. Se o chamador inicializou o pVar->vt campo na entrada, o recipiente de propriedades tentará alterar seu valor correspondente para esse tipo. Se o chamador definir pVar->vt como VT_EMPTY, o recipiente de propriedades poderá usar qualquer tipo conveniente.

pErrorLog

O endereço do log de erros do chamador no qual o recipiente de propriedades armazena os erros que ocorrem durante as leituras. Isso pode ser NULL; nesse caso, o chamador não recebe erros.

Retornar valor

Um HRESULT

Comentários

O método Read informa ao recipiente de propriedades para ler a propriedade chamada em pszPropName para a VARIANT inicializada pelo chamador em pVar. Os erros são registrados no log de erros apontado por pErrorLog. Quando pVar->vt especifica outro ponteiro de objeto (VT_UNKNOWN), o recipiente de propriedades é responsável por criar e inicializar o objeto descrito por pszPropName.

E_NOTIMPL não é um código de retorno válido, pois qualquer objeto que implemente essa interface deve dar suporte a toda a funcionalidade da interface.

Requisitos