Lynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

lynx_value_get_bool

Introduction

Read the bool value from lynx_value.

Syntax

lynx_api_status lynx_value_get_bool(lynx_api_env env,
                                    lynx_value value,
                                    bool* result);

Parameters

KeyDescription
[in] envThe environment in which lynx value runs, typically nullptr.
[in] valuelynx_value representing bool.
[out] resultThe bool value.

Return Value

Returns lynx_api_ok if the API succeeded. Returns lynx_api_bool_expected if the types do not match.

Example

bool ret;
lynx_api_status status =  lynx_value_get_bool(env, value, &ret);
if (status != lynx_api_ok) {
  // handle error.
}
Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.