Index Index for
Section 3
Index Alphabetical
listing for C
Bottom of page Bottom of
page

CRYPTO_set_ex_data(3)

NAME

CRYPTO_set_ex_data, CRYPTO_get_ex_data - Internal application specific data functions

SYNOPSIS

int CRYPTO_set_ex_data( CRYPTO_EX_DATA *r, int idx, void *arg ); void *CRYPTO_get_ex_data( CRYPTO_EX_DATA *r, int idx );

DESCRIPTION

Several OpenSSL structures can have application specific data attached to them. These functions are used internally by OpenSSL to manipulate application specific data attached to a specific structure. These functions should only be used by applications to manipulate CRYPTO_EX_DATA structures passed to the new_func(), free_func(), and dup_func() callbacks:, as passed to RSA_get_ex_new_index(), for example. The CRYPTO_set_ex_data() function is used to set application specific data. The data is supplied in the arg parameter and its precise meaning is up to the application. The CRYPTO_get_ex_data() function is used to retrieve application specific data. The data is returned to the application. This will be the same value as supplied to a previous CRYPTO_set_ex_data() call.

RETURN VALUES

The CRYPTO_set_ex_data() function returns 1 on success or 0 on failure. The CRYPTO_get_ex_data() function returns the application data or 0 on failure. Zero may also be valid application data but currently it can only fail if given an invalid idx parameter. On failure an error code can be obtained from ERR_get_error().

HISTORY

The CRYPTO_set_ex_data() and CRYPTO_get_ex_data() functions have been available since SSLeay 0.9.0.

SEE ALSO

Functions: RSA_get_ex_new_index(3), DSA_get_ex_new_index(3), DH_get_ex_new_index(3)

Index Index for
Section 3
Index Alphabetical
listing for C
Top of page Top of
page