GetConsoleVarAsString

From SA-MP Wiki

Jump to: navigation, search


Description:

Get the string value of a console variable.


Parameters:
(const varname[], buffer[], len)
const varname[]The name of the string variable to get the value of.
buffer[]An array into which to store the value, passed by reference.
lenThe length of the string that should be stored.


Return Values:

The length of the returned string. 0 if the specified console variable is not a string or doesn't exist.


Tip

Image:Light_bulb_icon.png

Type 'varlist' in the server console to display a list of available console variables and their types.


Image:32px-Ambox_warning_orange.png

Note

When filterscripts or plugins are specified as the varname, this function only returns the name of the first specified filterscript or plugin.


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

Warning

Using this function with anything other than a string (integer, boolean or float) will cause your server to crash. Using it with a nonexistent console variable will also cause your server to crash.


Example Usage:

public OnGameModeInit()
{
    new hostname[64];
    GetConsoleVarAsString("hostname", hostname, sizeof(hostname));
    printf("Hostname: %s", hostname);
}

Related Functions

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

Personal tools