Home

Traffic Server Software Developers Kit

INKMgmtStringGet

Get a records.config variable of type String.

Prototype

int INKMgmtStringGet (const char *var_name, INKMgmtString *result)

Arguments

var_name is the name of the variable you want from records.config

result is a pointer to the value of the variable. This value is of type INKMgmtString.

Description

INKMgmtStringGet obtains the value of the specified records.config variable of type String, and then stores the value in result.

When it's finished with the result, your plugin must deallocate the result string with a call to INKfree.

Returns

If INKMgmtStringGet could not get the variable, then it returns zero.

If successful, then a nonzero value is returned.