blob: dcb13b55b9f32eb645aeace33445a348471b1533 [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_object_set_property
## Summary
Set various properties of various kernel objects.
## Declaration
```c
#include <zircon/syscalls.h>
zx_status_t zx_object_set_property(zx_handle_t handle,
uint32_t property,
const void* value,
size_t value_size);
```
## Description
`zx_object_set_property()` modifies the value of a kernel object's property.
Setting a property requires **ZX_RIGHT_SET_PROPERTY** rights on the handle.
See [`zx_object_get_property()`] for a full description.
## Rights
*handle* must have **ZX_RIGHT_SET_PROPERTY**.
If *property* is **ZX_PROP_PROCESS_DEBUG_ADDR**, *handle* must be of type **ZX_OBJ_TYPE_PROCESS**.
If *property* is **ZX_PROP_PROCESS_BREAK_ON_LOAD**, *handle* must be of type **ZX_OBJ_TYPE_PROCESS**.
If *property* is **ZX_PROP_SOCKET_RX_THRESHOLD**, *handle* must be of type **ZX_OBJ_TYPE_SOCKET**.
If *property* is **ZX_PROP_SOCKET_TX_THRESHOLD**, *handle* must be of type **ZX_OBJ_TYPE_SOCKET**.
If *property* is **ZX_PROP_JOB_KILL_ON_OOM**, *handle* must be of type **ZX_OBJ_TYPE_JOB**.
## See also
- [`zx_object_get_property()`]
[`zx_object_get_property()`]: object_get_property.md