blob: 793b70e10ce337f281807a0d3b337058eb1b50de [file] [log] [blame] [view]
<!--
Copyright 2022 The Fuchsia Authors. All rights reserved.
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
DO NOT EDIT. Generated from FIDL library zx by zither, a Fuchsia platform tool.
See //docs/reference/syscalls/README.md#documentation-generation for
regeneration instructions.
-->
# zx_exception_get_thread
## Summary
Create a handle for the exception's thread.
## Declaration
```c
#include <zircon/syscalls.h>
zx_status_t zx_exception_get_thread(zx_handle_t handle, zx_handle_t* out);
```
## Description
*handle* is the exception handle.
*out* will be filled with a new handle to the exception thread. This handle
will have the same rights as the task given to
[`zx_task_create_exception_channel()`].
## Rights
*handle* must be of type **ZX_OBJ_TYPE_EXCEPTION**.
## Return value
`zx_exception_get_thread()` returns **ZX_OK** on success.
In the event of failure, a negative error value is returned.
## Errors
**ZX_ERR_BAD_HANDLE** *handle* is not a valid handle.
**ZX_ERR_NO_MEMORY** Failed to allocate memory for a new handle.
**ZX_ERR_WRONG_TYPE** *handle* is not an exception.
## See also
- [exceptions]
- [`zx_exception_get_process()`]
[exceptions]: /docs/concepts/kernel/exceptions.md
[`zx_exception_get_process()`]: exception_get_process.md
[`zx_task_create_exception_channel()`]: task_create_exception_channel.md