Definition at line 415 of file SQLDBC.h.
typedef enum SQLDBC::SQLDBC_ParameterMetaData::ParameterNullBehavior SQLDBC::SQLDBC_ParameterMetaData::ParameterNullBehavior |
typedef enum SQLDBC::SQLDBC_ParameterMetaData::ParameterMode SQLDBC::SQLDBC_ParameterMetaData::ParameterMode |
SQLDBC_Int2 SQLDBC::SQLDBC_ParameterMetaData::getParameterCount | ( | ) |
Returns the number of parameter/columns in the PreparedStatement or ResultSet object.
SQLDBC_Retcode SQLDBC::SQLDBC_ParameterMetaData::getParameterName | ( | SQLDBC_Int2 | param, | |
char * | buffer, | |||
const SQLDBC_StringEncoding | encoding, | |||
const SQLDBC_Length | bufferSize, | |||
SQLDBC_Length * | bufferLength | |||
) | const |
Requests the name of the specified parameter.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... | |
buffer | The buffer to store the name | |
encoding | The code of the name of the specified parameter | |
bufferSize | The buffer size in bytes of the buffer. | |
bufferLength | [out] The number of bytes stored in the buffer, not included the number of bytes necessary for the zero-terminator. If the source string exceeds the bufferSize value SQLDBC_DATA_TRUNC is returned and the bufferLength is set to the number of bytes required to store the name without truncation (not included the number of bytes necessary for the zero-terminator). |
SQLDBC_SQLType SQLDBC::SQLDBC_ParameterMetaData::getParameterType | ( | SQLDBC_Int2 | param | ) |
Returns the data type of the specified parameter.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |
ParameterMode SQLDBC::SQLDBC_ParameterMetaData::getParameterMode | ( | SQLDBC_Int2 | param | ) |
Returns the input/output behaviour of the specified parameter.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |
SQLDBC_Int4 SQLDBC::SQLDBC_ParameterMetaData::getParameterLength | ( | SQLDBC_Int2 | param | ) |
Returns the maximum width in characters of the data type of the specified parameter.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |
SQLDBC_Int4 SQLDBC::SQLDBC_ParameterMetaData::getPrecision | ( | SQLDBC_Int2 | param | ) |
Returns the number of decimal digits of the data type of the specified parameter.
For number types, getPrecision() returns the number of decimal digits. For character types, it returns the maximum length in characters. For binary types, it returns the maximum length in bytes.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |
SQLDBC_Int4 SQLDBC::SQLDBC_ParameterMetaData::getScale | ( | SQLDBC_Int2 | param | ) |
Returns the number of decimal places of the data type of the specified parameter.
For none numeric types, the scale is set to zero.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |
SQLDBC_Int4 SQLDBC::SQLDBC_ParameterMetaData::getPhysicalLength | ( | SQLDBC_Int2 | param | ) |
Returns maximum physical width in bytes of the data type of the specified parameter.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |
ParameterNullBehavior SQLDBC::SQLDBC_ParameterMetaData::isNullable | ( | SQLDBC_Int2 | param | ) |
Returns whether NULL values are allowed for the specified parameter values.
param | Index of the parameter. The first parameter is number 1, the second is number 2, ... |