pnSecAddSchema

add security schema

Synopsis

void pnSecAddSchema(component, schema);

Description

pnSecAddSchema() adds a component schema into the PostNuke system. The component schema list is not used anywhere inside PostNuke itself, but can be displayed as part of a GUI function to aid in configuration of the PostNuke permissions system.

Parameters

component

The component to which this authorisation schema applies

schema

The authorisation schema

Return Values

This function returns true if the authorisation schema is added successfully, false if the schema is not added successfully (normally due to a duplicate component name), and void if there was an internal API error whilst attempting to add the schema.

Notes

A full description of the PostNuke authorisation system is beyond the scope of this document. For more in formation on the authorisation system and its use of realms, components, and instances, please refer to the PostNuke Authorisation System documentation.

Note that this function was previously known as addinstanceschemainfo(). That name is deprecated but still functional in this version of the PostNuke API; it is recommended that any calls that are currently made to addinstanceschemainfo() are changed to pnSecAddSchema().

Examples

// Add security schema for foo module
pnSecAddSchema('Foo::', 'Name of foo:Type of foo:foo ID');