IXpsOMGlyphs::GetBidiLevel method (xpsobjectmodel.h)

Article
02/22/2024

Gets the level of bidirectional text.

Syntax

HRESULT GetBidiLevel(
  [out, retval] UINT32 *bidiLevel
);

Parameters

[out, retval] bidiLevel

The level of bidirectional text.

Range: 0–61

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code	Description
S_OK	The method succeeded.
E_POINTER	bidiLevel is NULL.

Remarks

The bidirectional text level, or BidiLevel, specifies the nesting level of the Unicode bidirectional algorithm. Even values imply the left-to-right layout and odd values the right-to-left layout, which places the run origin on the right side of the first glyph. Advance widths that are positive will move to the left, allowing subsequent glyphs to be placed to the left of the previous glyph.

The range of allowed values for this property is between 0 and 61, inclusive, and the default value is 0.

Requirements

Requirement	Value
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	xpsobjectmodel.h