IDWriteTextLayout::GetInlineObject method

Gets the inline object at the specified position.

Syntax

HRESULT GetInlineObject(
  UINT32              currentPosition,
  IDWriteInlineObject **inlineObject,
  DWRITE_TEXT_RANGE   *textRange
);

Parameters

currentPosition

Type: UINT32

The specified text position.

inlineObject

Type: IDWriteInlineObject**

Contains the application-defined inline object.

textRange

Type: DWRITE_TEXT_RANGE*

The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the inline object.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

   
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteTextLayout