Db field name

From SA-MP Wiki

Jump to: navigation, search

db_field_name

Image:Farm-Fresh text lowercase.png Note: This function name starts with a lowercase letter.


Description:

Returns the name of a field at a particular index.


Parameters:
(DBResult:dbresult, field, result[], maxlength)
DBResult:dbresultThe result to get the data from; returned by db_query.
fieldThe index of the field to get the name of.
result[]The result.
maxlengthThe max length of the field.


Return Values:

Returns 1, if the function was successful, otherwise 0 if DBResult:dbresult is a NULL reference or the column index not available.


Image:32px-Circle-style-warning.png

Warning

Using an invalid handle will crash your server! Get a valid handle by using db_query. But it's protected against NULL references.


Example Usage:

// Callback
public OnPlayerCommandText(playerid, cmdtext[])
{
	// If "cmdtext" equals "/getfieldnames"
	if(!strcmp(cmdtext, "/getfieldnames", true, 14))
	{
		// Declare "db_result", "i", and "columns"
		new DBResult:db_result = db_query(db_handle, "SELECT * FROM `join_log`"), i, columns = db_num_fields(db_result), info[30];
 
		// Iterate from 0 to "columns-1"
		for(; i < columns; i++)
		{
			// Store the name of the i indexed column name into "info"
			db_field_name(db_result, i, info, sizeof info);
 
			// Print "info"
			printf("Field name: %s", info);
		}
 
		// Frees the result
		db_free_result(db_result);
 
		// Returns 1
		return 1;
	}
 
	// Returns 0
	return 0;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.


  • db_open: Open a connection to an SQLite database
  • db_close: Close the connection to an SQLite database
  • db_field_name: Returns the name of a field at a particular index
  • db_get_field: Get content of field with specified ID from current result row
  • db_get_field_int: Get content of field as an integer with specified ID from current result row
  • db_get_field_float: Get content of field as a float with specified ID from current result row
In other languages