IXpsOMGlyphsEditor::SetProhibitedCaretStops method (xpsobjectmodel.h)

Article
02/22/2024

Sets an array of prohibited caret stop locations.

Syntax

HRESULT SetProhibitedCaretStops(
  [in] UINT32       count,
  [in] const UINT32 *prohibitedCaretStops
);

Parameters

[in] count

The number of prohibited caret stop locations in the array that is referenced by prohibitedCaretStops. A value of 0 clears the property.

[in] prohibitedCaretStops

The array of prohibited caret stop locations to be set. If count is 0, this parameter is ignored and can be set to NULL.

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	prohibitedCaretStops is NULL and count is greater than 0.
XPS_E_CARET_OUTOFORDER	A caret location value is out of order. The location values must be sorted in ascending order.

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.

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