IXpsOMGlyphsEditor::GetProhibitedCaretStopCount method (xpsobjectmodel.h)

Gets the number of prohibited caret stops.

Syntax

HRESULT GetProhibitedCaretStopCount(
  [out, retval] UINT32 *prohibitedCaretStopCount
);

Parameters

[out, retval] prohibitedCaretStopCount

The number of prohibited caret stops.

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.

Remarks

To get the prohibited caret stops, call GetProhibitedCaretStops.

Each caret stop index corresponds to the scalar values of a UTF-16 UnicodeString property. Index 0 represents the location just before the first UTF-16 scalar value of UnicodeString; index 1 represents the location between the first and second UTF-16 scalar values, and so on. There is an additional index at the end of UnicodeString. Any unspecified index is a valid caret stop location.

Requirements

See also

IXpsOMGlyphsEditor

XML Paper Specification

XPS Document Errors