IHostTaskManager::SetUILocale Method

Notifies the host that the common language runtime (CLR) has changed the user interface (UI) locale, or culture, on the currently executing task.

HRESULT SetUILocale (
    [in] LCID lcid
);

Parameters

  • lcid
    [in] The locale identifier value that maps to the newly assigned geographical culture and language.

Return Value

HRESULT Description

S_OK

SetUILocale returned successfully.

HOST_E_CLRNOTAVAILABLE

The CLR has not been loaded into a process, or the CLR is in a state in which it cannot run managed code or process the call successfully.

HOST_E_TIMEOUT

The call timed out.

HOST_E_NOT_OWNER

The caller does not own the lock.

HOST_E_ABANDONED

An event was canceled while a blocked thread or fiber was waiting on it.

E_FAIL

An unknown catastrophic failure occurred. When a method returns E_FAIL, the CLR is no longer usable within the process. Subsequent calls to hosting methods return HOST_E_CLRNOTAVAILABLE.

E_NOTIMPL

The host does not allow managed user code to change the UI culture.

Remarks

The runtime calls SetUILocale when the value of the System.Threading.Thread.CurrentUICulture property is changed by managed code. This method provides an opportunity for the host to execute any mechanisms it might have for synchronization of locales. If a host does not allow the UI locale to be changed from managed code, or does not implement a mechanism to synchronize locales, it should return E_NOTIMPL from this method.

Requirements

Platforms: Windows 2000, Windows XP, Windows Server 2003 family

Header: MSCorEE.idl

Library: Included as a resource in MSCorEE.dll

.NET Framework Version: 2.0

See Also

Reference

ICLRTask Interface
ICLRTaskManager Interface
IHostTask Interface
IHostTaskManager Interface
IHostTaskManager::SetLocale Method