Método IOleUIObjInfoA::GetObjectInfo (oledlg.h)

Obtém as informações de tamanho, tipo, nome e localização de um objeto.

Sintaxe

HRESULT GetObjectInfo(
  [in]            DWORD dwObject,
  [out]           DWORD *lpdwObjSize,
  [out, optional] LPSTR *lplpszLabel,
  [out, optional] LPSTR *lplpszType,
  [out, optional] LPSTR *lplpszShortType,
  [out, optional] LPSTR *lplpszLocation
);

Parâmetros

[in] dwObject

Identificador exclusivo do objeto.

[out] lpdwObjSize

Ponteiro para o tamanho do objeto, em bytes, no disco. Esse pode ser um valor aproximado.

[out, optional] lplpszLabel

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de rótulo do objeto. Esse parâmetro pode ser NULL para indicar que a implementação não deve retornar a cadeia de caracteres de rótulo.

[out, optional] lplpszType

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de tipo longo do objeto. Esse parâmetro pode ser NULL para indicar que a implementação não deve retornar a cadeia de caracteres de tipo longo.

[out, optional] lplpszShortType

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de tipo curto do objeto. Esse parâmetro pode ser NULL para indicar que a implementação não deve retornar a cadeia de caracteres de tipo curto.

[out, optional] lplpszLocation

Endereço de uma variável de ponteiro que recebe um ponteiro para a cadeia de caracteres de localização de origem do objeto. Esse parâmetro pode ser NULL para indicar que a implementação não deve retornar a cadeia de caracteres de localização.

Retornar valor

Esse método retorna S_OK com êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno Descrição
E_FAIL
Falha na operação.
E_INVALIDARG
O identificador especificado é inválido.
E_OUTOFMEMORY
Não há memória suficiente disponível para esta operação.

Comentários

As cadeias de caracteres e o tamanho do objeto são exibidos na página Geral das propriedades do objeto.

Anotações aos implementadores

Sua implementação de GetObjectInfo deve colocar cada um dos atributos do objeto nos parâmetros out fornecidos. Defina lpdwObjSize como (DWORD)-1 quando o tamanho do objeto for desconhecido. Aloque todas as cadeias de caracteres (o restante dos parâmetros) com o alocador de tarefas OLE obtido por meio de CoGetMalloc, como é padrão para todas as interfaces OLE com parâmetros de cadeia de caracteres [out], ou você pode simplesmente usar CoTaskMemAlloc.

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 oledlg.h

Confira também

Cogetmalloc

Cotaskmemalloc

IOleUIObjInfo