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

Obtiene la información de tamaño, tipo, nombre y ubicación de un objeto .

Sintaxis

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 único del objeto.

[out] lpdwObjSize

Puntero al tamaño del objeto, en bytes, en disco. Puede ser un valor aproximado.

[out, optional] lplpszLabel

Dirección de una variable de puntero que recibe un puntero a la cadena de etiqueta del objeto. Este parámetro puede ser NULL para indicar que la implementación no debe devolver la cadena de etiqueta.

[out, optional] lplpszType

Dirección de una variable de puntero que recibe un puntero a la cadena de tipo long del objeto. Este parámetro puede ser NULL para indicar que la implementación no debe devolver la cadena de tipo long.

[out, optional] lplpszShortType

Dirección de una variable de puntero que recibe un puntero a la cadena de tipo corto del objeto. Este parámetro puede ser NULL para indicar que la implementación no debe devolver la cadena de tipo corto.

[out, optional] lplpszLocation

Dirección de una variable de puntero que recibe un puntero a la cadena de ubicación de origen del objeto. Este parámetro puede ser NULL para indicar que la implementación no debe devolver la cadena de ubicación.

Valor devuelto

Este método devuelve S_OK cuando funciona correctamente. Otros posibles valores devueltos son los siguientes.

Código devuelto	Descripción
E_FAIL	Error en la operación.
E_INVALIDARG	El identificador especificado no es válido.
E_OUTOFMEMORY	No hay memoria suficiente disponible para esta operación.

Comentarios

Las cadenas y el tamaño del objeto se muestran en la página Propiedades del objeto General .

Notas para los implementadores

La implementación de GetObjectInfo debe colocar cada uno de los atributos del objeto en los parámetros out proporcionados. Establezca lpdwObjSize en (DWORD)-1 cuando se desconoce el tamaño del objeto. Asigne todas las cadenas (el resto de los parámetros) con el asignador de tareas OLE obtenido a través de CoGetMalloc, como es estándar para todas las interfaces OLE con parámetros de cadena [out] o simplemente puede usar CoTaskMemAlloc.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	oledlg.h

Consulte también

CoGetMalloc

CoTaskMemAlloc

IOleUIObjInfo