Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

Contact Template

OUInfo()

Returns OU information.

See Also

rb.contact.createOU
rb.contact.Delete
rb.contact.createOU

Syntax

OUData = rb.contact.OUInfo(ID, uName)

Parameters

The 'OUInfo' method takes 2 parameters:

Name Type/Value Range/Length Description
IDnumber-1, or positive integer Required. Either -1, meaning return the OU with Unique Name uName, or a valid OU ID as returned from a previous createOU() or get() call
uNamestring1-31 characters Optional. If ID == -1, then the OU with the given uName is returned, otherwise this field is ignored and may be empty.

Results

The 'OUInfo' method returns structure:

Type/Value Range/Length Description
struct OUData see definition OU information.
If no OU which matches the parameters exists, then an undef type will be returned instead of the struct.

Example

The following code gets OU information for the OU "mega":
	  var mega = rb.contact.OUInfo(-1, "mega");

	  if(mega != null)
	  rb.page.write("OU name is "+mega.name+"<BR>");
Whitebeam release 1.3.36
(loadtime : 92ms)