Cpanel::NVData::get

This article documents the usage of the Cpanel::NVData::get function in relation to the cPanel interface. This tag can be used inside cPanel pages.

SYNOPSIS

Cpanel::NVData::get

DESCRIPTION

Gets a variable from the non-volatile data store.

VARIABLES

INPUT

encoded (boolean)
Whether or not the variable value is XML encoded. (Yes = 1, No = 0)

default (string)
What the function should return if there is no value set for the variable.

names (string)
Pipe delimited list of names of the variables to get.

OUTPUT

value (string)
Value of the non-volatile variable.

name (string)
name of the non-volatile variable.

EXAMPLES

<?cp NVData::get(%,value) encoded=1,names=brandingpkg ?>

This example will get the value of the variable named 'brandingpkg'

COPYRIGHT

Copyright 2007 cPanel Inc.