JSONGETARRAYSTART

JSONGETARRAYSTART(p,n) checks whether the next character, ignoring whitespace, in a piece of JSON text is an opening bracket [. This function returns a size_t 1 value that is equal to the number of bytes read.

If the number of available bytes n is greater than zero, JSONGETARRAYSTART(p,n) attempts to read an opening bracket [ from the buffer.

  • When the first character after any whitespace is the desired character [, the number of bytes read includes 1 byte for the desired character plus any bytes of whitespace preceding it.
  • When the first character after any whitespace is not the desired character [, a value of zero is returned.
Read syntax diagramSkip visual syntax diagramJSONGETARRAYSTART( p, n)
p
A pointer that specifies the address of a buffer to be read.
n
A size_t value that specifies the number of available bytes in the buffer.