<?xml version="1.0" encoding="utf-8"?>

<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.simdjson-key-exists">

<refnamediv>

<refname>simdjson_key_exists</refname>

<refpurpose>Check if the JSON contains the value referred to by a JSON pointer.</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>simdjson_key_exists</methodname>

<methodparam><type>string</type><parameter>json</parameter></methodparam>

<methodparam><type>string</type><parameter>key</parameter></methodparam>

<methodparam choice="opt"><type>int</type><parameter>depth</parameter></methodparam>

</methodsynopsis>

<simpara>

Count the number of elements of the object/array found at the requested JSON pointer.

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>json</parameter></term>

<listitem>

<simpara>

The <parameter>json</parameter> <type>string</type> being queried.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>key</parameter></term>

<listitem>

<simpara>

The JSON pointer <type>string</type>.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>depth</parameter></term>

<listitem>

<simpara>

Maximum nesting depth of the structure being validated.

The value must be greater than <literal>0</literal>,

and less than or equal to <literal>2147483647</literal>.

Callers should use reasonably small values,

because larger depths require more buffer space and will

increase the recursion depth, unlike the current <function>json_decode</function> implementation.

</simpara>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>throw_if_uncountable</parameter></term>

<listitem>

<simpara>

When true, a <classname>SimdJsonException</classname> will be thrown

instead of returning 0 when the value the JSON pointer points to

is neither an object nor an array.

</simpara>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

Returns &true; if the JSON pointer is valid and refers to a value found within a valid JSON string.

Returns &false; if the JSON is valid but does not contain the JSON pointer.

</simpara>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->