IXpsOMGlyphs::GetProhibitedCaretStops method (xpsobjectmodel.h)

Gets an array of prohibited caret stop locations.

Syntax

HRESULT GetProhibitedCaretStops(
  [in, out] UINT32 *prohibitedCaretStopCount,
  [out]     UINT32 *prohibitedCaretStops
);

Parameters

[in, out] prohibitedCaretStopCount

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

[out] prohibitedCaretStops

An array of prohibited caret stop locations; if such are not 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.

Remarks

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.

Requirements

See also

GetProhibitedCaretStopCount

IXpsOMGlyphs

XML Paper Specification

XPS Document Errors