get_key_value_parameter()

get_key_value_parameter()#

Parse a key-value pair parameter from a string.

Prototype

PUBLIC BOOL get_key_value_parameter(
    const char  *parameter,
    char        *key,
    int          key_size,
    char        *value,
    int          value_size
);
        

Parameters

Key

Type

Description

parameter

const char *

The string containing the key-value pair.

key

char *

The buffer to store the extracted key.

key_size

int

The size of the key buffer.

value

char *

The buffer to store the extracted value.

value_size

int

The size of the value buffer.


Return Value

Returns TRUE if the key-value pair was successfully parsed, otherwise returns FALSE.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples