docs/reference/syscalls/object_set_profile.md

<!--
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_profile

## Summary

Apply a scheduling profile to a thread.

## Declaration

```c
#include <zircon/syscalls.h>

zx_status_t zx_object_set_profile(zx_handle_t handle,
                                  zx_handle_t profile,
                                  uint32_t options);
```

## Description

`zx_object_set_profile()` applies a [profile] to the object specified by *target*.

The parameter *profile* is a handle to a [profile] object created with [`zx_profile_create()`].

*options* is currently ignored, and should be set to `0` by callers.

Currently, the the only supported *target* object type is [thread]. Other object types may be
supported in the future.

[profile]: /docs/reference/kernel_objects/profile.md
[thread]: /docs/reference/kernel_objects/thread.md

## Rights

*handle* must be of type **ZX_OBJ_TYPE_THREAD** and have **ZX_RIGHT_MANAGE_THREAD**.

*profile* must be of type **ZX_OBJ_TYPE_PROFILE** and have **ZX_RIGHT_APPLY_PROFILE**.

## Return value

Returns **ZX_OK** on success. In the event of failure, a negative error value is returned.

## Errors

**ZX_ERR_BAD_HANDLE**  *target* is not a valid handle.

**ZX_ERR_WRONG_TYPE**  *target* is not a thread handle.

**ZX_ERR_ACCESS_DENIED**  *target* does not have **ZX_RIGHT_MANAGE_THREAD** right.

**ZX_ERR_BAD_STATE**  When *target* is a thread that is still being created, is dying, or dead, and
cannot have a *profile* applied to it.

## See also

 - [`zx_profile_create()`]

[`zx_profile_create()`]: profile_create.md