ec_message_context_delete

March 26, 2020 Contributors

Name

ec_message_context_delete — Delete a key/value pair from the message context or connection context dictionary

Synopsis

#include "ec_message.h"

| int **ec_message_context_delete** ( | m, |   |
|   | w, |   |
|   | k); |   |

ec_message * <var class="pdparam">m</var>;
int <var class="pdparam">w</var>;
const char * <var class="pdparam">k</var>;

Description

Delete a key/value pair from either the message context or connection context dictionary.

Parameters

message

A pointer to an ec_message struct. For documentation of this data structure see “ec_message”

w

An integer. Valid values are either ECMESS_CTX_CONN or ECMESS_CTX_MESS.

k

A constant string (char *) which is the dictionary key.

Return Values

Returns 1 if the key existed and was deleted. Returns 0 if the key does not exist.

Threading

It is legal to call this function in any thread.

See Also

ec_message_context_exists, ec_message_context_exists_and_get and ec_message_context_set