IXpsOMGlyphs::GetProhibitedCaretStopCount method
Gets the number of prohibited caret stops.
Syntax
HRESULT GetProhibitedCaretStopCount(
[out, retval] UINT32 *prohibitedCaretStopCount
);
Parameters
- prohibitedCaretStopCount [out, retval]
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.
| Return code | Description |
|---|---|
| S_OK | The method succeeded. |
| E_POINTER | prohibitedCaretStopCount is NULL. |
Remarks
GetProhibitedCaretStops gets the prohibited caret stops.
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
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
Header |
Xpsobjectmodel.h |
IDL |
XpsObjectModel.idl |