Lynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

lynx_value_remove_reference

Introduction

Decrement the reference count by 1 for pointer data.

Syntax

lynx_api_status lynx_value_remove_reference(
    lynx_api_env env, lynx_value value, lynx_value_ref ref);

Parameters

KeyDescription
[in] envThe environment in which lynx value runs, typically nullptr.
[in] valuelynx_value to be removed ref.
[out] reflynx_value_ref to be remove if exist.

Return Value

Returns lynx_api_ok if the API succeeded.

Example

lynx_value val;
lynx_api_status status = lynx_value_create_array(env, &val);
if (status != lynx_api_ok) {
  // handle error.
}
// do something.
lynx_value_remove_reference(env, val, 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.