napi_delete_element

ohos_sys::napi

Function napi_delete_element 

Source 
pub unsafe extern "C" fn napi_delete_element(
    env: napi_env,
    object: napi_value,
    index: u32,
    result: *mut bool,
) -> napi_status
Available on crate feature napi only.
Expand description

Delete the special index from the given ArkTS Array.

§Arguments

  • env - Current running virtual machine context.

  • object - The ArkTS Array.

  • index - The index of the element to delete.

  • result - Whether the execution is succeed or not. Can optionally be ignored by passing nullptr.

§Returns

  • Returns the function execution status. [napi_ok] If the function executed successfully.

[napi_invalid_arg] If the param env, object and(or) key is nullptr.

[napi_object_expected] If the param object is not an ArkTS Object.

[napi_pending_exception] If have uncaught exception, or exception occurred in execution.

Available since API-level: 10