getAreaByName()

The method returns area information for the area with the specified name.

Synopsis

public shared_ptr<UserManagementArea> getAreaByName(string name);

Parameter Description
name The name of the area for which the information is returned.

Return Value

Area information for the area with the specified name.

Errors

Errors are shown in the log viewer.

EXAMPLE

#uses "classes/userManagement/UserManagement"
main(mapping event)
{
  mapping areaData = makeMapping();
  shared_ptr<UserManagement> userMgm = UserManagement::getInstance();
  DebugN("getAreaByName:", userMgm.getAreaByName("area2"));
  //returns the area information for the area "area2"
}

Assignment

User administration

See also

getAllAreas(), getArea(), addArea()