warning Not Translated

This page has not been translated into the language that your browser requested yet. The English content is being shown as a fallback.

If you want to contribute a translation for this page then please click here.

GetConsoleVarAsString

Description

Get the string value of a console variable.

Name	Description
const cvar[]	The name of the string variable to get the value of.
buffer[]	An array into which to store the value, passed by reference.
len = sizeof (buffer)	The length of the string that should be stored.

Returns

The length of the returned string.

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

Examples

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

Notes

tip

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

tip

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

warning

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

Related Functions

GetConsoleVarAsInt: Retreive a server variable as an integer.
GetConsoleVarAsBool: Retreive a server variable as a boolean.