Lynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

lynx_value_get_named_property

Introduction

Read value from lynx_value of map type by given key.

Syntax

lynx_api_status
lynx_value_get_named_property(lynx_api_env env, lynx_value object,
                              const char* utf8name, lynx_value* result);

Parameters

KeyDescription
[in] envThe environment in which lynx value runs, typically nullptr.
[in] objectThe lynx_value to query.
[in] utf8nameThe name of the property to get.
[out] resultThe value of the property.

Return Value

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

Example

After using the extracted result, memory needs to be freed using lynx_value_remove_reference.

lynx_value ret;
lynx_api_status status = lynx_value_get_named_property(env, map_value, "v1", &ret);
if (status != lynx_api_ok) {
  // handle error.
}
// do something
lynx_value_remove_reference(env, ret, NULL);
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.