IOleUIObjInfoW::GetObjectInfo method (oledlg.h)

Article
07/27/2022

Gets the size, type, name, and location information for an object.

Syntax

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

Parameters

[in] dwObject

Unique identifier for the object.

[out] lpdwObjSize

Pointer to the object's size, in bytes, on disk. This may be an approximate value.

[out, optional] lplpszLabel

Address of a pointer variable that receives a pointer to the object's label string. This parameter may be NULL to indicate that the implementation should not return the label string.

[out, optional] lplpszType

Address of a pointer variable that receives a pointer to the object's long type string. This parameter may be NULL to indicate that the implementation should not return the long type string.

[out, optional] lplpszShortType

Address of a pointer variable that receives a pointer to the object's short type string. This parameter may be NULL to indicate that the implementation should not return the short type string.

[out, optional] lplpszLocation

Address of a pointer variable that receives a pointer to the object's source location string. This parameter may be NULL to indicate that the implementation should not return the location string.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return code	Description
E_FAIL	The operation failed.
E_INVALIDARG	The specified identifier is invalid.
E_OUTOFMEMORY	There is insufficient memory available for this operation.

Remarks

The strings and the object's size are displayed in the object properties General page.

Notes to Implementers

Your implementation of GetObjectInfo should place each of the object's attributes in the out parameters provided. Set lpdwObjSize to (DWORD)-1 when the size of the object is unknown. Allocate all strings (the rest of the params) with the OLE task allocator obtained via CoGetMalloc, as is standard for all OLE interfaces with [out] string parameters, or you can simply use CoTaskMemAlloc.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	oledlg.h