GetSecurity Method (IPISecurity2 interface)

              

 

Gets the security attributes for the object. These attributes are returned in a NamedValues collection.

 

Syntax

object.GetSecurity

The object placeholder is an object that evaluates to a reference to an IPISecurity2 interface.  See the Applies To list in the IPISecurity2 definition for a list of objects that support this interface.

 

Remarks

The NamedValues collection returned will contain the following items:

Name

Value

Owner

A string with the name of the PIUser who is the owner of the object.

Group

A string with the name of the PIGroup whose access rights are specified in the Access attribute

Access

String that specifies the access rights of the owner, group, and world. Example: "o:wr g:r w:r"

Security

PI 3.4.380 servers or later only. This security string contains an Access Control List (ACL) of PI Identities and their access rights. 
Example:
"piadmin: A(r,w) | PIAdministrators: A(r) | piworld: A(r)".

 

The Security attribute supersedes the Owner, Group, and Access attributes. The Owner, Group, and Access attributes are returned to be backwards compatible with applications that use them.

 

Trappable Errors

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

Error

Description

pseNOGENSERVER and psePISERVERDBBASENOTINITIALIZEDERROR

The underlying server abstraction layer could not be accessed.

 

Enabling Operational Intelligence