IXpsOMVisual::GetLanguage method
Gets the Language property of the visual and of its contents.
Syntax
HRESULT GetLanguage(
[out, retval] LPWSTR *language
);
Parameters
- language [out, retval]
The language string that specifies the language of the page. If a language 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 Language property that is set by this method specifies the language of the resource content.
This method allocates the memory that is used by the string returned in language. If language is not NULL, use the CoTaskMemFree function to free the memory.
Internet Engineering Task Force (IETF) RFC 3066 specifies the recommended encoding for the Language property.
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 |