main/syscalls/debuglog_create.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_debuglog_create

## Summary

Create an object allowing access to the kernel debuglog.

## Declaration

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

zx_status_t zx_debuglog_create(zx_handle_t resource,
                               uint32_t options,
                               zx_handle_t* out);
```

## Description

`zx_debuglog_create()` creates an object allowing access to the kernel
debuglog using the `zx_debuglog_read()` and `zx_debuglog_write()` syscalls.

If *options* is set to `0`, the returned handle will have the
`ZX_RIGHT_WRITE` right, giving write-only access to the kernel debuglog. If
*options* is set to `ZX_LOG_FLAG_READABLE`, the returned handle will
additionally have `ZX_RIGHT_READ`, giving read/write access to the kernel
debuglog.

## Rights

*resource* must have resource kind `ZX_RSRC_KIND_SYSTEM` and base `ZX_RSRC_SYSTEM_DEBUGLOG_BASE`.

## Return value

`zx_debuglog_create()` returns `ZX_OK` on success, returning a handle to the
created object in *out*.

In the event of failure, a negative error value is returned.

## Errors

`ZX_ERR_INVALID_ARGS`  *options* contained a value not understood by the kernel

`ZX_ERR_WRONG_TYPE`  *resource* was not of the kind `ZX_RSRC_KIND_SYSTEM` and base `ZX_RSRC_SYSTEM_DEBUGLOG_BASE`.

`ZX_ERR_NO_MEMORY`  Failure due to lack of memory.

## See also

 - [`zx_debuglog_read()`](https://fuchsia.dev/reference/syscalls/debuglog_read)
 - [`zx_debuglog_write()`](https://fuchsia.dev/reference/syscalls/debuglog_write)