RDM Encryption API
Collaboration diagram for RDM Encryption API:

Functions

RDM_RETCODE rdm_encryptFree (RDM_ENCRYPT enc)
Free an encryption context. More...
RDM_RETCODE rdm_encryptGetType (RDM_ENCRYPT enc, RDM_ENC_TYPE *ptype)
Get the encryption type for an allocated encryption context. More...

Detailed Description

The encryption library. The functions here are located in RDM Encrytion Library. Linker option:

    -lrdmenc

See the Encryption for how to instantiate an encryption context.

Function Documentation

rdm_encryptFree()

RDM_RETCODE rdm_encryptFree ( RDM_ENCRYPT enc )

#include <rdmencryptapi.h>

Free an encryption context.

This function will cleanup and free an encryption context. Once the encryption context and been freed it will not be used when open a database.

Locking Requirements
None
See also
rdm_tfsAllocEncrypt
Return values
sOKAY Success
Parameters
enc Pointer to an encryption context
Examples
core18Example_main.c.

rdm_encryptGetType()

RDM_RETCODE rdm_encryptGetType ( RDM_ENCRYPT enc,
RDM_ENC_TYPE * ptype
)

#include <rdmencryptapi.h>

Get the encryption type for an allocated encryption context.

This function will return the encryption type for an allocated encryption context.

Locking Requirements
None
See also
rdm_encryptFree
Return values
sOKAY Success
Parameters
enc [IN] An encryption context
ptype [OUT] A pointer to a RDM_ENC_TYPE