C Driver API 3.0.0
API for the NuoDB C Driver Library
Loading...
Searching...
No Matches
resultSet.h
Go to the documentation of this file.
1/* (C) Copyright 2015-2023 Dassault Systemes SE. All Rights Reserved. */
2
3#ifndef _NUODB_RESULTSET_H_
4#define _NUODB_RESULTSET_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#ifndef _NUODB_LOB_H_
19#include "nuodb/lob.h"
20#endif
21
22#ifndef _NUODB_TEMPORAL_H_
23#include "nuodb/temporal.h"
24#endif
25
26/* c-driver */
27#ifdef __cplusplus
28extern "C" {
29#endif
30
82{
84 _NuoDB_ResultSet_state_t* _state;
85
104 NuoDB_Status (* getLob)(NuoDB_ResultSet* _this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob** lobPtr);
105
124 NuoDB_Status (* getUnmanagedLob)(NuoDB_ResultSet* _this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob** lobPtr);
125
144 NuoDB_Status (* getTemporal)(NuoDB_ResultSet* _this, int column, NuoDB_Temporal_Type temporalType, NuoDB_Temporal** temporalPtr);
145
160 NuoDB_Status (* getBoolean)(NuoDB_ResultSet* _this, int column, nuodb_bool_t* boolPtr);
161
184 NuoDB_Status (* getString)(NuoDB_ResultSet* _this, int column, const char **strPtr);
185
205 NuoDB_Status (* getStringWithLength)(NuoDB_ResultSet* _this, int column, size_t* length, const char **strPtr);
206
225 NuoDB_Status (* getBytes)(NuoDB_ResultSet* _this, int column, size_t* length, const char **bytes);
226
241 NuoDB_Status (* getShort)(NuoDB_ResultSet* _this, int column, short* shortPtr);
242
258 NuoDB_Status (* getByte)(NuoDB_ResultSet* _this, int column, char* charPtr);
259
275 NuoDB_Status (* getDouble)(NuoDB_ResultSet* _this, int column, double *doublePtr);
276
292 NuoDB_Status (* getLong)(NuoDB_ResultSet* _this, int column, int64_t* longPtr);
293
309 NuoDB_Status (* getInt)(NuoDB_ResultSet* _this, int column, int32_t* intPtr);
310
329 NuoDB_Status (* getLobByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, NuoDB_Lob_Type lobType, NuoDB_Lob** lobPtr);
330
349 NuoDB_Status (* getTemporalByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, NuoDB_Temporal_Type temporalType, NuoDB_Temporal** temporalPtr);
350
365 NuoDB_Status (* getBooleanByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, nuodb_bool_t* boolPtr);
366
391 NuoDB_Status (* getStringByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, const char **strPtr);
392
412 NuoDB_Status (* getStringWithLengthByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, size_t* length, const char **strPtr);
413
433 NuoDB_Status (* getBytesByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, size_t* length, const char **bytes);
434
449 NuoDB_Status (* getShortByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, short* shortPtr);
450
466 NuoDB_Status (* getByteByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, char* charPtr);
467
483 NuoDB_Status (* getDoubleByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, double *doublePtr);
484
500 NuoDB_Status (* getLongByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, int64_t* longPtr);
501
517 NuoDB_Status (* getIntByLabel)(NuoDB_ResultSet* _this, const char* columnLabel, int32_t* intPtr);
518
541
559
569
580
591 NuoDB_ResultSetMetaData* (* getMetaData)(NuoDB_ResultSet* _this);
592
603 NuoDB_Status (* findColumn)(NuoDB_ResultSet* _this, const char* columnLabel, int* position);
604
614 NuoDB_Status (* setFetchSize)(NuoDB_ResultSet* _this, int fetchSize);
615
625};
626
637NUODB_CAPI void NUODB_CAPICALL NuoDB_ResultSet_free(NuoDB_ResultSet* results);
638
639#ifdef __cplusplus
640} /* extern "C" { */
641#endif
642
643#endif /* end of: #ifndef _NUODB_RESULTSET_H_ */
NuoDB Error information.
enum NuoDB_Status_enum NuoDB_Status
Status codes used by the C Driver.
Definition error.h:130
NuoDB Large Object.
enum NuoDB_Lob_Type_enum NuoDB_Lob_Type
Large object types used by NuoDB_Lob.
Definition lob.h:65
NUODB_CAPI void NUODB_CAPICALL NuoDB_ResultSet_free(NuoDB_ResultSet *results)
Frees the specified NuoDB_ResultSet.
NuoDB Large Object
Definition lob.h:79
Table of data representing a database result set.
Definition resultSet.h:82
NuoDB_Status(* getIntByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, int32_t *intPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:517
NuoDB_Status(* getLob)(NuoDB_ResultSet *_this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:104
NuoDB_Status(* getBytes)(NuoDB_ResultSet *_this, int column, size_t *length, const char **bytes)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:225
NuoDB_Status(* findColumn)(NuoDB_ResultSet *_this, const char *columnLabel, int *position)
Find the position of a column in a result set.
Definition resultSet.h:603
NuoDB_Status(* getShortByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, short *shortPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:449
NuoDB_Status(* getTemporal)(NuoDB_ResultSet *_this, int column, NuoDB_Temporal_Type temporalType, NuoDB_Temporal **temporalPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:144
NuoDB_Status(* close)(NuoDB_ResultSet *_this)
Close the result set on the server side.
Definition resultSet.h:624
nuodb_bool_t(* isActive)(NuoDB_ResultSet *_this)
Returns true if the result set is active.
Definition resultSet.h:579
NuoDB_Status(* getDouble)(NuoDB_ResultSet *_this, int column, double *doublePtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:275
NuoDB_Status(* getShort)(NuoDB_ResultSet *_this, int column, short *shortPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:241
NuoDB_Status(* getInt)(NuoDB_ResultSet *_this, int column, int32_t *intPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:309
NuoDB_Status(* getByteByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, char *charPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:466
NuoDB_Status(* getBytesByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, size_t *length, const char **bytes)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:433
int(* getNumberColumns)(NuoDB_ResultSet *_this)
Returns the number of columns.
Definition resultSet.h:568
NuoDB_Status(* getByte)(NuoDB_ResultSet *_this, int column, char *charPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:258
NuoDB_Status(* next)(NuoDB_ResultSet *_this)
Moves the cursor froward one row from its current position.
Definition resultSet.h:540
NuoDB_Status(* getLongByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, int64_t *longPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:500
NuoDB_Status(* getLobByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:329
NuoDB_Status(* getString)(NuoDB_ResultSet *_this, int column, const char **strPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:184
NuoDB_Status(* getBooleanByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, nuodb_bool_t *boolPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:365
nuodb_bool_t(* wasNull)(NuoDB_ResultSet *_this)
Reports whether the last column read had a value of SQL NULL.
Definition resultSet.h:558
NuoDB_Status(* getLong)(NuoDB_ResultSet *_this, int column, int64_t *longPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:292
NuoDB_Status(* getUnmanagedLob)(NuoDB_ResultSet *_this, int column, NuoDB_Lob_Type lobType, NuoDB_Lob **lobPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:124
NuoDB_Status(* getDoubleByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, double *doublePtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:483
NuoDB_Status(* getStringByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, const char **strPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:391
NuoDB_Status(* getStringWithLengthByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, size_t *length, const char **strPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:412
NuoDB_Status(* getBoolean)(NuoDB_ResultSet *_this, int column, nuodb_bool_t *boolPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:160
NuoDB_Status(* getStringWithLength)(NuoDB_ResultSet *_this, int column, size_t *length, const char **strPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:205
NuoDB_Status(* getTemporalByLabel)(NuoDB_ResultSet *_this, const char *columnLabel, NuoDB_Temporal_Type temporalType, NuoDB_Temporal **temporalPtr)
Retrieves the value of the designated column in the current row of this NuoDB_ResultSet data structur...
Definition resultSet.h:349
NuoDB_Status(* setFetchSize)(NuoDB_ResultSet *_this, int fetchSize)
Setup of the fetch size.
Definition resultSet.h:614
Data structure used to obtain metadata for a NuoDB_ResultSet.
Definition resultSetMetaData.h:69
Data structure used to represent temporal information.
Definition temporal.h:59
structs and typedefs.
Data structure used to represent temporal information.
enum NuoDB_Temporal_Type_enum NuoDB_Temporal_Type
Constant temporal types used by NuoDB_Temporal.
Definition temporal.h:51
NuoDB utilities.
unsigned char nuodb_bool_t
NuoDB boolean type.
Definition utils.h:49