MySQL 8.4.2
Source Code Documentation
s_mysql_mysql_command_field_info Struct Reference

A service that provides the apis for mysql command field info, fetch_field, num_fields, fetch_fields and field_count. More...

#include <mysql_command_services.h>

Public Attributes

mysql_service_status_t(* fetch_field )(MYSQL_RES_H res_h, MYSQL_FIELD_H *field_h)
 Calls mysql_fetch_field api to returns the type of next table field. More...
 
mysql_service_status_t(* num_fields )(MYSQL_RES_H res_h, unsigned int *num_fields)
 Calls mysql_num_fields api to returns the number of columns in a result set. More...
 
mysql_service_status_t(* fetch_fields )(MYSQL_RES_H res_h, MYSQL_FIELD_H **fields_h)
 Calls mysql_fetch_fields api to returns an array of all field structures. More...
 
mysql_service_status_t(* field_count )(MYSQL_H mysql_h, unsigned int *num_fields)
 Calls mysql_field_count api to returns the number of columns for the most resent statement. More...
 

Detailed Description

A service that provides the apis for mysql command field info, fetch_field, num_fields, fetch_fields and field_count.

Member Data Documentation

◆ fetch_field

mysql_service_status_t(* s_mysql_mysql_command_field_info::fetch_field) (MYSQL_RES_H res_h, MYSQL_FIELD_H *field_h)

Calls mysql_fetch_field api to returns the type of next table field.

Parameters
[in]res_hAn mysql result object to return the next table field.
[out]*field_hStores the definition of one column of a result set as a MYSQL_FIELD structure
Return values
truefailure
falsesuccess

◆ fetch_fields

mysql_service_status_t(* s_mysql_mysql_command_field_info::fetch_fields) (MYSQL_RES_H res_h, MYSQL_FIELD_H **fields_h)

Calls mysql_fetch_fields api to returns an array of all field structures.

Parameters
[in]res_hA valid mysql result set object.
[out]**fields_hStores the array of all fields for a result set.
Return values
truefailure
falsesuccess

◆ field_count

mysql_service_status_t(* s_mysql_mysql_command_field_info::field_count) (MYSQL_H mysql_h, unsigned int *num_fields)

Calls mysql_field_count api to returns the number of columns for the most resent statement.

Parameters
[in]mysql_hA valid mysql handle object.
[out]*num_fieldsStores the number of columns for the last stmt.
Return values
truefailure
falsesuccess

◆ num_fields

mysql_service_status_t(* s_mysql_mysql_command_field_info::num_fields) (MYSQL_RES_H res_h, unsigned int *num_fields)

Calls mysql_num_fields api to returns the number of columns in a result set.

Parameters
[in]res_hA valid mysql result set object.
[out]*num_fieldsStores the number of columns in the result set.
Return values
truefailure
falsesuccess

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