getPersonPropertiesBySearchExp

Returns properties about a person or group.

Syntax

getPersonPropertiesBySearchExp(searchProp, searchExpr, returnSize)
Table 1. getPersonPropertiesBySearchExp syntax
Parameter Data type Description
searchProp integer The searchProp parameter controls the type of search. Type 0 for group names, 1 for surnames, or 2 for given names.
searchExpr string The searchExpr parameter controls what is searched and is not case sensitive. A wildcard asterisk (*) is supported. For example if searchExpr="mike", find any user or group named "mike". If searchExpr="m*", then find any user or group beginning with the letter "m". If searchExpr="*m", find any user or group ending with the letter "m". Note that "*XXX*" is not a valid search expression.
returnSize integer The returnSize parameter is the number of search results to be returned.

Purpose

The getPersonPropertiesBySearchExp command allows you return properties such as surname or group name using a search expression. Note that group email addresses are not supported and thus do not appear in search results.

Sample

The example that follows searches for surnames beginning with "m".
set ons [$AdminControl completeObjectName type=RTCAdminMbean,*]
$AdminControl invoke $ons getPersonPropertiesBySearchExp "2 m* 3"

C2E755D60DDD18968525719A00642F8E
mail5
mail5@us.ibm.com
9DB3D27FF355A6568525719A00643C0C
mail7
mail7@us.ibm.com
04687B65F5492BA58525719A006448A3
mail9
mail9@us.ibm.com