NuoDB_ParameterMetaData Struct Reference

Metadata about parameters. More...

#include <parameterMetaData.h>

Data Fields
_NuoDB_ParameterMetaData_state_t *	_state
int(*	getParameterCount )(NuoDB_ParameterMetaData *_this)
	Retrieves the number of parameters in the last prepared SQL statement for which this ParameterMetaData data structure contains information.
NuoDB_Status(*	getParameterMode )(NuoDB_ParameterMetaData *_this, int index, NuoDB_ParameterDirection *modePtr)
	Retrieves the designated parameter's mode (direction)
NuoDB_Status(*	getParameterType )(NuoDB_ParameterMetaData *_this, int index, NuoDB_Type *typePtr)
	Retrieves the designated parameter's SQL type.
int(*	getPrecision )(NuoDB_ParameterMetaData *_this, int index)
	Retrieves the designated parameter's specified column size.
int(*	getScale )(NuoDB_ParameterMetaData *_this, int index)
	Retrieves the designated parameter's number of digits to right of the decimal point.
nuodb_bool_t(*	isNullable )(NuoDB_ParameterMetaData *_this, int index)
	Retrieves whether null values are allowed in the designated parameter.

Detailed Description

Metadata about parameters.

NuoDB_ParameterMetaData is used to obtain information about parameters.

Field Documentation

getParameterCount

int(* NuoDB_ParameterMetaData::getParameterCount) (NuoDB_ParameterMetaData *_this)

Retrieves the number of parameters in the last prepared SQL statement for which this ParameterMetaData data structure contains information.

Parameters

[in]

_this

a pointer to the current (this) data structure.

Returns

the number of parameters

getParameterMode

NuoDB_Status(* NuoDB_ParameterMetaData::getParameterMode) (NuoDB_ParameterMetaData *_this, int index, NuoDB_ParameterDirection *modePtr)

Retrieves the designated parameter's mode (direction)

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first parameter is 1, the second is 2, ...
[out]	modePtr	a pointer to NuoDB_ParameterDirection.

Returns

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

getParameterType

NuoDB_Status(* NuoDB_ParameterMetaData::getParameterType) (NuoDB_ParameterMetaData *_this, int index, NuoDB_Type *typePtr)

Retrieves the designated parameter's SQL type.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first parameter is 1, the second is 2, ...
[out]	typePtr	a pointer to NuoDB_Type.

Returns

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

getPrecision

int(* NuoDB_ParameterMetaData::getPrecision) (NuoDB_ParameterMetaData *_this, int index)

Retrieves the designated parameter's specified column size.

The returned value represents the maximum column size for the given parameter. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first parameter is 1, the second is 2, ...

Returns

the precision for the given parameter. -1 is returned when an error occurs.

getScale

int(* NuoDB_ParameterMetaData::getScale) (NuoDB_ParameterMetaData *_this, int index)

Retrieves the designated parameter's number of digits to right of the decimal point.

Retrieves the designated parameter's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first parameter is 1, the second is 2, ...

Returns

the scale for the given parameter or 0 if scale is not applicable. -1 is returned when an error occurs.

isNullable

nuodb_bool_t(* NuoDB_ParameterMetaData::isNullable) (NuoDB_ParameterMetaData *_this, int index)

Retrieves whether null values are allowed in the designated parameter.

Retrieves whether null values are allowed in the designated parameter.

Parameters

[in]	_this	a pointer to the current (this) data structure.
[in]	index	the first parameter is 1, the second is 2, ...

Returns

NUODB_TRUE if the given parameter allows NULL values

---

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

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