pnModSetVar

set module variable

Synopsis

bool pnModSetVar(module, name, value);

Description

pnModSetVar() sets a module-specific variable on the PostNuke system. If the variable does not exist then it is created.

Parameters

module

The well-known name of a module for which to set the variable

name

The name of the module variable to set

value

The value to set the module variable with

Return Values

This function returns true if the update is successful. This function returns void if an exception was raised.

Exceptions

This function raises BAD_PARAM if you pass an invalid parameter. This function raises DATABASE_ERROR if an error occurs while querying data.

Notes

For more information on well-known names of modules please refer to the documentation for pnModGetVar()

Examples

// Set the version information for the 'News' module
pnModSetVar('News', 'Version', 2);
       

See Also

pnModGetVar(), pnModDelVar()