pips_multimap_dup_string()

Updated: April 19, 2023

Express the current multimap as a string

Synopsis:

#include <pips/multimap.h>
char* pips_multimap_dup_string(const pips_multimap_t *multimap)

Arguments:

multimap
A pointer to the pips_multimap_t instance to convert to a JSON string

Library:

pips-client

Description:

This utility function converts the current pips_multimap_t instance into a JSON string. The JSON string is composed of a single object containing one or more key-value mappings.

Returns:

On success, a character string, allocated on the heap, expressing the current multimap as a JSON object. The returned string becomes owned by the caller, who is responsible for deleting it. On error, NULL (errno is set).

Errors:

  • ENOTTY: The multimap is not valid.