GetServerVarAsString

From SA-MP Wiki

Jump to: navigation, search


Image:50px-Ambox_outdated_serious.png This function, as of 0.3.7 R2, is deprecated. Please see GetConsoleVarAsString


Description:

Get the string value of a server 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 server variable is not a string or doesn't exist.


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

Warning

Using this function on anything other than a string (int, bool or float) or a nonexistent server variable, will crash your server! This is a bug.


Example Usage:

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

Image:Light_bulb_icon.png

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


Image:32px-Ambox_warning_orange.png

Note

When filterscripts or plugins is specified as the varname, this function only returns the name of the first specified filterscript or plugin. This is a bug.


Related Functions

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

Personal tools