CEF4Delphi/docs/html/uCEFInterfaces.ICefTaskManager.html
2024-09-03 17:26:03 +02:00

114 lines
7.4 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>cef4delphi: uCEFInterfaces: Interface ICefTaskManager</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0-snapshot">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<span id="ICefTaskManager"></span><h1 class="cio">Interface ICefTaskManager</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></div><div class="one_section">Fields</div><div class="one_section"><a class="section" href="#PasDoc-Methods">Methods</a></div><div class="one_section">Properties</div></div>
<span id="PasDoc-Description"></span><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="uCEFInterfaces.html">uCEFInterfaces</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type ICefTaskManager = interface(<a class="normal" href="uCEFInterfaces.ICefBaseRefCounted.html">ICefBaseRefCounted</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Interface that facilitates managing the browser-related tasks. The functions of this structure may only be called on the UI thread. </p>
<p>
<p>&lt;see href=&quot;<a href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_task_manager_capi.h">https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/cef_task_manager_capi.h</a>&quot;&gt;CEF source file: /include/capi/cef_task_manager_capi.h (cef_task_manager_t))</p>
<span id="PasDoc-Hierarchy"></span><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">IInterface</li>
<li class="ancestor"><a class="normal" href="uCEFInterfaces.ICefBaseRefCounted.html">ICefBaseRefCounted</a></li>
<li class="thisitem">ICefTaskManager</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Methods"></span><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="uCEFInterfaces.ICefTaskManager.html#GetTasksCount">GetTasksCount</a></strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="uCEFInterfaces.ICefTaskManager.html#GetTaskIdsList-TCefCustomInt64Array-">GetTaskIdsList</a></strong>(var task_ids: <a href="uCEFTypes.html#TCefCustomInt64Array">TCefCustomInt64Array</a>): boolean;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="uCEFInterfaces.ICefTaskManager.html#GetTaskInfo-int64-TCustomTaskInfo-">GetTaskInfo</a></strong>(const task_id: int64; var info: <a href="uCEFTypes.TCustomTaskInfo.html">TCustomTaskInfo</a>): boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="uCEFInterfaces.ICefTaskManager.html#KillTask-int64-">KillTask</a></strong>(task_id: int64): boolean;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <strong><a href="uCEFInterfaces.ICefTaskManager.html#GetTaskIdForBrowserId-Integer-">GetTaskIdForBrowserId</a></strong>(browser_id: Integer): int64;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetTasksCount"></span><code>function <strong>GetTasksCount</strong>: <a href="uCEFTypes.html#NativeUInt">NativeUInt</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the number of tasks currently tracked by the task manager. Returns 0 if the function was called from the incorrect thread. </p>
<h6 class="description_section">Attributes</h6>
<dl class="attributes">
<dt>GUID['{913B6FE7-1543-407D-9A23-8C232103965B}']</dt>
<dd></dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetTaskIdsList-TCefCustomInt64Array-"></span><code>function <strong>GetTaskIdsList</strong>(var task_ids: <a href="uCEFTypes.html#TCefCustomInt64Array">TCefCustomInt64Array</a>): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets the list of task IDs currently tracked by the task manager. Tasks that share the same process id will always be consecutive. The list will be sorted in a way that reflects the process tree: the browser process will be first, followed by the gpu process if it exists. Related processes (e.g., a subframe process and its parent) will be kept together if possible. Callers can expect this ordering to be stable when a process is added or removed. The task IDs are unique within the application lifespan. Returns false (0) if the function was called from the incorrect thread. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetTaskInfo-int64-TCustomTaskInfo-"></span><code>function <strong>GetTaskInfo</strong>(const task_id: int64; var info: <a href="uCEFTypes.TCustomTaskInfo.html">TCustomTaskInfo</a>): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Gets information about the task with |task_id|. Returns true (1) if the information about the task was successfully retrieved and false (0) if the |task_id| is invalid or the function was called from the incorrect thread. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="KillTask-int64-"></span><code>function <strong>KillTask</strong>(task_id: int64): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Attempts to terminate a task with |task_id|. Returns false (0) if the |task_id| is invalid, the call is made from an incorrect thread, or if the task cannot be terminated. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><span id="GetTaskIdForBrowserId-Integer-"></span><code>function <strong>GetTaskIdForBrowserId</strong>(browser_id: Integer): int64;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns the task ID associated with the main task for |browser_id| (value from cef_browser_t::GetIdentifier). Returns -1 if |browser_id| is invalid, does not currently have an associated task, or the function was called from the incorrect thread. </p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
</span>
</body></html>