main/syscalls/ktrace_read.md

<!--
Copyright 2023 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_ktrace_read

## Summary

TODO(https://fxbug.dev/42108078)

## Declaration

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

zx_status_t zx_ktrace_read(zx_handle_t handle,
                           void* data,
                           uint32_t offset,
                           size_t data_size,
                           size_t* actual);
```

## Description

To use the `zx_ktrace_read()` function, you must specify
`kernel.enable-debugging-syscalls=true` on the kernel command line. Otherwise,
the function returns `ZX_ERR_NOT_SUPPORTED`.

TODO(https://fxbug.dev/42108078)

## Rights

*handle* must have resource kind `ZX_RSRC_KIND_SYSTEM` with base
`ZX_RSRC_SYSTEM_TRACING_BASE`.

## Return value

TODO(https://fxbug.dev/42108078)

## Errors

TODO(https://fxbug.dev/42108078)

## See also

TODO(https://fxbug.dev/42108078)