IXpsOMGlyphsEditor::GetUnicodeString method

Gets the text in unescaped UTF-16 scalar values.

Syntax


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

Parameters

unicodeString [out, retval]

The UTF-16 Unicode string. 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 codeDescription
S_OK

The method succeeded.

E_POINTER

unicodeString is NULL.

 

Remarks

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

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

See also

IXpsOMGlyphsEditor
XPS Document Errors
XML Paper Specification

 

 

Show: