Db get field assoc

From SA-MP Wiki

Jump to: navigation, search

db_get_field_assoc

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


Description:

Get the contents of field with specified name.


Parameters:
(DBResult:dbresult, const field[], result[], maxlength)
DBResult:dbresultThe result to get the data from
field[]The fieldname to get the data from
result[]The result
maxlengthThe max length of the field


Return Values:

Returns 1 if 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:

// Example function
GetNameBySpawnID(spawn_id)
{
	// Declare "p_name"
	new p_name[MAX_PLAYER_NAME+1];
 
	// Declare "query" and "db_result"
	static query[61], DBResult:db_result;
 
	// Formats "query"
	format(query, sizeof query, "SELECT `PlayerName` FROM `spawn_log` WHERE `ID`=%d;", spawn_id);
 
	// Selects the player name by using "spawn_id"
	db_result = db_query(db_handle, query);
 
	// If there is any valid entry
	if(db_num_rows(db_result))
	{
		// Store data from "PlayerName" into "p_name"
		db_get_field_assoc(db_result, "PlayerName", p_name, sizeof p_name);
	}
 
	// Frees the result
	db_free_result(db_result);
 
	// Returns "p_name"
	return p_name;
}

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_assoc: Get content of field with specified name 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