ICLRTask::NeedsPriorityScheduling Method

Gets a value that indicates whether the current task, which is being switched out, needs to be marked as a high priority for rescheduling.

HRESULT NeedsPriorityScheduling (
    [out] BOOL *pbNeedsPriorityScheduling
);

Parameters

• pbNeedsPriorityRescheduling
  [out] true, if the host should attempt to reschedule the current task instance as soon as possible; otherwise, false.

Return Value

HRESULT	Description
S_OK	NeedsPriorityRescheduling returned successfully.
HOST_E_CLRNOTAVAILABLE	The common language runtime (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.

Remarks

In situations where the task is close to being collected by the garbage collector, the CLR sets the value of pbNeedsPriorityScheduling to true, indicating high-priority rescheduling. This allows the host to reschedule the task quickly, thereby minimizing the potential for delays in garbage collection, and enabling the host and the runtime to cooperate in conserving memory resources.

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