C Driver API 3.0.0
API for the NuoDB C Driver Library
Loading...
Searching...
No Matches
lob.h
Go to the documentation of this file.
1/* (C) Copyright 2015-2023 Dassault Systemes SE. All Rights Reserved. */
2
3#ifndef _NUODB_LOB_H_
4#define _NUODB_LOB_H_ 1
5
6#ifndef _NUODB_UTILS_H_
7#include "nuodb/utils.h"
8#endif
9
10#ifndef _NUODB_STRUCTS_H_
11#include "nuodb/structs.h"
12#endif
13
14#ifndef _NUODB_ERROR_H_
15#include "nuodb/error.h"
16#endif
17
18/* c-driver */
19#ifdef __cplusplus
20extern "C" {
21#endif
22
63
66
67
79{
81 _NuoDB_Lob_state_t* _state;
82
90 size_t (* getLength)(const NuoDB_Lob* _this);
91
102 size_t (* getCharLength)(const NuoDB_Lob* _this);
103
111 const char* (* getData)(const NuoDB_Lob* _this);
112
125 NuoDB_Status (* setData)(NuoDB_Lob* _this, const char* buffer, size_t len);
126
135
136};
137
157NUODB_CAPI NuoDB_Lob* NUODB_CAPICALL NuoDB_Lob_create(NuoDB_Connection* connection, NuoDB_Lob_Type type);
158
164NUODB_CAPI void NUODB_CAPICALL NuoDB_Lob_free(NuoDB_Lob* lob);
165
166#ifdef __cplusplus
167} /* extern "C" { */
168#endif
169
170#endif /* end of: #ifndef _NUODB_LOB_H_ */
NuoDB Error information.
enum NuoDB_Status_enum NuoDB_Status
Status codes used by the C Driver.
Definition error.h:130
NUODB_CAPI void NUODB_CAPICALL NuoDB_Lob_free(NuoDB_Lob *lob)
Free a NuoDB_Lob data structure.
NuoDB_Lob_Type_enum
Enum defining large object types used by NuoDB_Lob.
Definition lob.h:29
@ NUODB_CLOB_TYPE
Representation of a Character Large Object (CLOB) value to be stored as a column value in a row of a ...
Definition lob.h:51
@ NUODB_BYTES_TYPE
Representation of Binary to be stored as a column value in a row of a table.
Definition lob.h:60
@ NUODB_BLOB_TYPE
Representation of a Binary Large Object value to be stored as a column value in a row of a table.
Definition lob.h:41
NUODB_CAPI NuoDB_Lob *NUODB_CAPICALL NuoDB_Lob_create(NuoDB_Connection *connection, NuoDB_Lob_Type type)
Create a NuoDB_Lob data structure.
enum NuoDB_Lob_Type_enum NuoDB_Lob_Type
Large object types used by NuoDB_Lob.
Definition lob.h:65
NuoDB Database Connection.
Definition connection.h:97
NuoDB Large Object
Definition lob.h:79
size_t(* getLength)(const NuoDB_Lob *_this)
Returns the current length of the Lob data.
Definition lob.h:90
NuoDB_Status(* setData)(NuoDB_Lob *_this, const char *buffer, size_t len)
Sets a pointer to client's data buffer.
Definition lob.h:125
NuoDB_Lob_Type(* getType)(const NuoDB_Lob *_this)
Returns the type of Lob data.
Definition lob.h:134
size_t(* getCharLength)(const NuoDB_Lob *_this)
Returns the number of UTF-8 characters in the Lob data.
Definition lob.h:102
structs and typedefs.
NuoDB utilities.