IXpsOMGlyphs::GetUnicodeString method (xpsobjectmodel.h)

Article
02/22/2024

Gets the text in unescaped UTF-16 scalar values.

Syntax

HRESULT GetUnicodeString(
  [out, retval] LPWSTR *unicodeString
);

Parameters

[out, retval] unicodeString

The UTF-16 Unicode string of the text to be displayed. If the string is empty, 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
S_OK	The method succeeded.
E_POINTER	unicodeString is NULL.

Remarks

This method allocates the memory that is used by the string returned in unicodeString. If unicodeString is not NULL, use the CoTaskMemFree function to free the memory.

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