Remove Method (PIGroups collection)

               

 

Removes an existing PIGroup from a server.

 

Syntax

object.Remove GroupName

The Remove method syntax has these parts:

Part

Description

object

An object expression that evaluates to a PIGroups collection.

GroupName

A string containing the name of the group to be removed as returned by the PIGroup.Name property.

 

Remarks

Removing a group from the server will only succeed if the caller has write access to the user database on the server. This access is controlled through server specific means to maintain an environment with the desired level of security.

Removing a group that currently is the owning group for resources on a server (for example PIPoint objects) can make these resources harder to access.

 

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 remove a PIGroup

pseNOEMPTYSTRINGS

The passed group name may not be blank.

pseGROUPNOTFOUND

The passed group name does not exist on the server.

pseGROUPREMOVE

Unable to remove the group on the server. See the error description for more information.

Enabling Operational Intelligence