MYSQL_RES *mysql_get_metadata(MYSQL_STMT
*stmt)
Descrição
Se uma instrução passada para
mysql_prepare()
rproduziu um resultado,
mysql_get_metadata()
retorna o resultado
dos meta dados na forma de um ponteiro para uma estrutura
MYSQL_RES
que também pode ser usada para
processar a meta informação como o número total de campos e
informação de campos indivíduais. Este ponteriro para o
resultado pode ser passado como um argumento para qualquer um
dos campos com base na API que processam o resultado dos
metadados, como:
mysql_num_fields()
mysql_fetch_field()
mysql_fetch_field_direct()
mysql_fetch_fields()
mysql_field_count()
mysql_field_seek()
mysql_field_tell()
mysql_free_result()
A estrutura do resultado deve estar liberada quando você
acabar de usá-lo. Você pode fazê-lo passando para
mysql_free_result()
. É semelhante ao modo
que você libera um resulatdo chamado com
mysql_store_result()
.
O resultado retornado por
mysql_get_metadata()
contém apenas
metadados. Ele não contém qualquer resultado de registro. As
linhas são obtidas usando o handle de instrução com
mysql_fetch()
.
Valor Retornado
Uma estrutura de resultado MYSQL_RES
.
NULL
se nenhuma meta informação existe
para a consulta preparada.
Erros
CR_OUT_OF_MEMORY
Falta de memória
CR_UNKNOWN_ERROR
Ocorreu um erro desconhecido
Exemplo
Para utilizar mysql_get_metadata()
consulte
o exemplo de Secção 12.1.7.13, “mysql_fetch()
”
This is a translation of the MySQL Reference Manual that can be found at dev.mysql.com. The original Reference Manual is in English, and this translation is not necessarily as up to date as the English version.