validate_context_exists_and_get

March 26, 2020 Contributors

Name

validate_context_exists_and_get — If a validation context key exists, then retrieve its value

Synopsis

#include "validate.h"

| int **validate_context_exists_and_get** ( | vctx, |   |
|   | which, |   |
|   | key, |   |
|   | value); |   |

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

Description

If the specified validation context key exists, then retrieve its value.

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.

value

The associated value.

Return Value

Returns 1 if the key exists, 0 if it does not exist. If the key exists its value can be found at *value.

Threading

It is legal to call this function in any thread.

See Also

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