IXpsOMPage::GetLanguage method
Gets the Language property of the page.
Syntax
HRESULT GetLanguage(
[out, retval] LPWSTR *language
);
Parameters
- language [out, retval]
A language tag string that represents the language of the page contents. If the Language property has not been set, 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 | language is NULL. |
Remarks
The default value is the language tag string that is passed to IXpsOMObjectFactory::CreatePage in the language parameter.
Internet Engineering Task Force (IETF) RFC 3066 describes the recommended encoding of the language tag string that is returned in language.
This method allocates the memory used by the string that is returned in language. If language 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 |