Aqualogic Interaction API  
 

IPTUserGroup.PreviewDynamicMembershipRule Method 

Returns an IPTQueryResult that shows what users match the given IPTFilter. This function does not update the dynamic members of this group. Because the search for matching users is done in real-time, this function may take some time to return related users.

NOTE: If this is a remote group, a PTException of type PT_RESULTCODES.PT_E_USERGROUP_IS_REMOTE will be thrown.

Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME, PT_PROPID_USER_LOGINNAME.

IPTQueryResult PreviewDynamicMembershipRule(
   IPTFilter pRules
);

Parameters

pRules
- a valid IPTFilter

Return Value

the user information, in an IPTQueryResult

See Also

IPTUserGroup Interface | com.plumtree.server Namespace | IPTQueryResult | PT_PROPIDS