validate_context_get

March 26, 2020 Contributors

Name

validate_context_get — Retrieve the value associated with a message context key or connection context key

Synopsis

#include "validate.h"

| const char * **validate_context_get** ( | vctx, |   |
|   | which, |   |
|   | key); |   |

validate_context * <var class="pdparam">vctx</var>;
int <var class="pdparam">which</var>;
const char * <var class="pdparam">key</var>;

Description

Retrieve the value associated with a message context key or connection context key.

Parameters

vctx

The validation context. For documentation of this data structure see “validate_context”.

which

An integer, typically VCTX_MESS or VCTX_CONN, which determines which dictionary to consult: the connection context or the message context dictionary.

key

The key to query.

Return Value

Returns the value associated with the key, if it exists. If the key does not exist in the validation context, then a reference to an empty string ("") is returned.

Threading

It is legal to call this function in any thread.

See Also

validate_context_exists, validate_context_exists_and_get, validate_context_set, validate_context_delete, validate_context_init, and validate_context_destroy.