options.h File Reference

Container for NuoDB_Connection options. More...

#include "nuodb/utils.h"
#include "nuodb/structs.h"

Go to the source code of this file.

Data Structures
struct	NuoDB_Options
	Container for NuoDB_Connection options. More...

Functions
NUODB_CAPI NuoDB_Options *NUODB_CAPICALL	NuoDB_Options_create ()
	Create a NuoDB_Options container.
NUODB_CAPI void NUODB_CAPICALL	NuoDB_Options_free (NuoDB_Options *ops)
	Free NuoDB_Options container.

Detailed Description

Container for NuoDB_Connection options.

Function Documentation

NuoDB_Options_create()

NUODB_CAPI NuoDB_Options *NUODB_CAPICALL NuoDB_Options_create

(

)

Create a NuoDB_Options container.

This is a factory function for creating NuoDB_Options. NuoDB_Options are a container that holds a list NuoDB Database connection options. Clients should call the NuoDB_Options_free() function to release the resources held by the NuoDB_Options data structure.

NuoDB_Options_free()

NUODB_CAPI void NUODB_CAPICALL NuoDB_Options_free

(

NuoDB_Options *

ops

)

Free NuoDB_Options container.

This function is used to free the resources held by the specified NuoDB_Options container. The client must not use the NuoDB_Options data structure after it has been freed. NuoDB_Connection::openDatabase() does not keep a reference to this container, so it can be freed immediately.

Parameters

[in]

ops

a pointer to the NuoDB_Options data structure.