pnModDelVar

delete a module variable

Synopsis

bool pnModDelVar(module, name);

Description

pnModDelVar() deletes a module-specific variable from the PostNuke system.

Parameters

module

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

name

The name of the module variable to delete

Return Values

This function returns true if the deletion 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

// Delete news numitems variable
if (!pnModDelVar('News', 'numitems')) {
  die('Error deleting News variable numitems');
}
       

See Also

pnModGetVar(), pnModSetVar()