IRichEditOle::GetObject method (richole.h)

Retrieves information, stored in a REOBJECT structure, about an object in a rich edit control.

Syntax

HRESULT GetObject(
  LONG     iob,
  REOBJECT *lpreobject,
  DWORD    dwFlags
);

Parameters

iob

Type: LONG

Zero-based index that specifies which object to return information about. If this parameter is REO_IOB_USE_CP, information about the object at the character position specified by the REOBJECT structure is returned.

lpreobject

Type: REOBJECT*

Structure that receives information about the object. The reference count of the interfaces returned in this structure has been incremented; it is the responsibility of the caller to use the Release method to decrement the count.

dwFlags

Type: DWORD

Operation flags that specify which interfaces to return in the structure. The dwFlags parameter can be a combination of the following values.

Value	Meaning
REO_GETOBJ_POLEOBJ	Get object interface.
REO_GETOBJ_PSTG	Get storage interface.
REO_GETOBJ_POLESITE	Get site interface.
REO_GETOBJ_NO_INTERFACES	Get no interfaces.
REO_GETOBJ_ALL_INTERFACES	Get all interfaces.

Return value

Type: HRESULT

Returns S_OK if successful, or an error value otherwise. E_INVALIDARG is returned if no buffer for the REOBJECT structure was given or if the iob value or character position is invalid.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	richole.h
DLL	Msftedit.dll

See also

IRichEditOle

REOBJECT

Reference