RemoveUser Method (PIGroup object)

                  

 

This method removes the named PIUser from the PIGroup.

 

Syntax

object.RemoveUser UserName

The RemoveUser method syntax has these parts:

Part

Description

object

An object expression that evaluates to a PIGroup object.

UserName

A string containing the name of the PIUser which should be removed from the group.

 

Remarks

PIUser names can be retrieved from PIUser objects that are obtained from the Server.PIUsers collection or from another PIGroup.PIUsers collection. Only logged on user's who have write access to the server's user database can successfully remove users from groups. Access permissions on the user database are maintained on the server for security (for PI on Windows NT and UNIX systems this is stored in the DBSecurity table).

 

Trappable Errors

In addition to generic errors (such as Out of Memory), the following errors may occur:

Error

Description

pseACCESSDENIED

Caller does not have sufficient privilege to modify the PIGroup.

pseNOEMPTYSTRINGS

Caller does not have sufficient privilege to modify the PIGroup. The passed user name must be non-blank.

pseUSRNOTINGROUP

The passed user is not a member of the group.

pseUSERDATAUPDATE

Unable to update user data on the server.

Enabling Operational Intelligence