blob: d7d44acfc5b3776ac7eb16f38248a77f608a3225 [file] [log] [blame] [view] [edit]
# zx_handle_replace
## NAME
<!-- Updated by update-docs-from-fidl, do not edit. -->
Replace a handle.
## SYNOPSIS
<!-- Updated by update-docs-from-fidl, do not edit. -->
```c
#include <zircon/syscalls.h>
zx_status_t zx_handle_replace(zx_handle_t handle,
zx_rights_t rights,
zx_handle_t* out);
```
## DESCRIPTION
`zx_handle_replace()` creates a replacement for *handle*, referring to
the same underlying object, with new access rights *rights*.
*handle* is always invalidated.
If *rights* is **ZX_RIGHT_SAME_RIGHTS**, the replacement handle will
have the same rights as the original handle. Otherwise, *rights* must be
a subset of original handle's rights.
## RIGHTS
<!-- Updated by update-docs-from-fidl, do not edit. -->
None.
## RETURN VALUE
`zx_handle_replace()` returns **ZX_OK** and the replacement handle (via *out*)
on success.
## ERRORS
**ZX_ERR_BAD_HANDLE** *handle* isn't a valid handle.
**ZX_ERR_INVALID_ARGS** The *rights* requested are not a subset of
*handle*'s rights or *out* is an invalid pointer.
**ZX_ERR_NO_MEMORY** Failure due to lack of memory.
There is no good way for userspace to handle this (unlikely) error.
In a future build this error will no longer occur.
## SEE ALSO
- [`zx_handle_close()`]
- [`zx_handle_close_many()`]
- [`zx_handle_duplicate()`]
<!-- References updated by update-docs-from-fidl, do not edit. -->
[`zx_handle_close()`]: handle_close.md
[`zx_handle_close_many()`]: handle_close_many.md
[`zx_handle_duplicate()`]: handle_duplicate.md