IXpsOMGlyphsEditor::GetProhibitedCaretStops method (xpsobjectmodel.h)

Gets an array of prohibited caret stop locations.


HRESULT GetProhibitedCaretStops(
  [in, out] UINT32 *count,
  [out]     UINT32 *prohibitedCaretStops


[in, out] count

The number of prohibited caret stop values that will fit in the array that is referenced by the prohibitedCaretStops parameter. When the method returns, prohibitedCaretStopCount will contain the number of values in that array.

[out] prohibitedCaretStops

An array of glyph mapping values. If no prohibited caret stops have been defined, a NULL pointer is returned.

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
The method succeeded.
prohibitedCaretStopCount, prohibitedCaretStops, or both were NULL.
prohibitedCaretStops was not large enough to receive the prohibited caret stop data. prohibitedCaretStopCount contains the required number of elements.


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.

GetProhibitedCaretStopCount gets the number of prohibited caret stops.

A caret stop is the index of the UTF-16 code point in the UnicodeString property of the glyph.


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

See also


XML Paper Specification

XPS Document Errors