NuoDB_Lob Struct Reference

NuoDB Large Object More...

#include <lob.h>

Data Fields
_NuoDB_Lob_state_t *	_state
size_t(*	getCharLength )(const NuoDB_Lob *_this)
	Returns the number of UTF-8 characters in the Lob data.
const char *(*	getData )(const NuoDB_Lob *_this)
	Gets a pointer to Lob data.
size_t(*	getLength )(const NuoDB_Lob *_this)
	Returns the current length of the Lob data.
NuoDB_Lob_Type(*	getType )(const NuoDB_Lob *_this)
	Returns the type of Lob data.
NuoDB_Status(*	setData )(NuoDB_Lob *_this, const char *buffer, size_t len)
	Sets a pointer to client's data buffer.

Detailed Description

NuoDB Large Object

NuoDB_Lob is a container which is used to represent any of the following SQL Lob types:

• Blob
• Clob
• Bytes

Field Documentation

getCharLength

size_t(* NuoDB_Lob::getCharLength) (const NuoDB_Lob *_this)

Returns the number of UTF-8 characters in the Lob data.

Parameters

[in]

_this

a pointer to the current (this) data structure.

Returns

length of Lob data in UTF-8 characters.

Remarks

if the type of the Lob is not NUODB_CLOB_TYPE, the results are undefined

getData

const char *(* NuoDB_Lob::getData) (const NuoDB_Lob *_this)

Gets a pointer to Lob data.

Parameters

[in]

_this

a pointer to the current (this) data structure.

Returns

a pointer to the Lob data as an array of bytes.

getLength

size_t(* NuoDB_Lob::getLength) (const NuoDB_Lob *_this)

Returns the current length of the Lob data.

Parameters

[in]

_this

a pointer to the current (this) data structure.

Returns

length of Lob data in bytes.

getType

NuoDB_Lob_Type(* NuoDB_Lob::getType) (const NuoDB_Lob *_this)

Returns the type of Lob data.

Parameters

[in]

_this

a pointer to the current (this) data structure.

Returns

pointer to Lob type.

setData

NuoDB_Status(* NuoDB_Lob::setData) (NuoDB_Lob *_this, const char *buffer, size_t len)

Sets a pointer to client's data buffer.

Makes a shallow copy of the client data pointer.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	buffer	Client data pointer as an array of bytes.
[in]	len	Data length in bytes.

Returns

Enumerated integer NuoDB_Status. NUODB_SUCCESS (integer 0) on success, or a negative integer on failure.

---

The documentation for this struct was generated from the following file:

• /data/builds/RELEASE-DB17-LIN/CDriver/nuodb/lob.h