'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH odbx_column_name 3 "5 September 2014" "" OpenDBX
.SH NAME
odbx_column_name \- Get the name of a column in the current result set
.SH SYNOPSIS
'nh
.nf
\*(T<#include <opendbx/api.h>\*(T>
.fi
.sp 1
.PP
.fi
.ad l
\*(T<char* \fBodbx_column_name\fR\*(T> \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
\*(T<(odbx_result_t* \fIresult\fR, unsigned long \fIpos\fR);\*(T>
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\*(T<\fBodbx_column_name\fR\*(T>() gets the name of the column specified by pos in the current result set returned by \*(T<\fBodbx_result\fR\*(T>(). The column names will not change within the result set with the exception described for MySQL in \*(T<\fBodbx_column_count\fR\*(T>() when the first result set wasn't retrieved completely before \*(T<\fBodbx_result\fR\*(T>() was called again.
.PP
The \*(T<result\*(T> parameter required by this function must be a valid result set returned by \*(T<\fBodbx_result\fR\*(T>() and must not have been feed to \*(T<\fBodbx_result_finish\fR\*(T>() before.
.PP
Valid column indices for the requested column provided via \*(T<pos\*(T> start with zero and end with the value returned by \*(T<\fBodbx_column_count\fR\*(T>() minus one.
.SH "RETURN VALUE"
The return value of \*(T<\fBodbx_column_name\fR\*(T>() is a pointer to a zero terminated string which consists of the name of the requested column. This pointer is allocated by the database client library and must not be freed by the application. The content of the string may be overwritten by the next call to \*(T<\fBodbx_column_name\fR\*(T>()
.SH ERRORS
Errors can occur if the given \*(T<result\*(T> parameter is NULL or invalid or if the value of \*(T<pos\*(T> is out of range, i.e. more than \*(T<\fBodbx_column_count\fR\*(T>() minus one.
.SH "SEE ALSO"
\*(T<\fBodbx_column_count\fR\*(T>(), \*(T<\fBodbx_column_type\fR\*(T>(), \*(T<\fBodbx_result\fR\*(T>()