TIBCO EMS .NET API 8.5 TIBCO EMS .NET API 8.5

- Main Page
- Related Pages
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Properties | List of all members
TIBCO.EMS.ADMIN.PrincipalInfo Class Reference

This abstract class represents a user or group and contains methods common to both. More...

Inheritance diagram for TIBCO.EMS.ADMIN.PrincipalInfo:

## Public Member Functions
override string | ToString ()
| Generate a string representation of this PrincipalInfo. More...

## Properties
string | Name`[get]`
| Get the name of this user or group. More...
string | Description`[get, set]`
| Get or set the description of this user or group. More...
bool | External`[get]`
| Indicates whether or not this user or group is external. More...

## Detailed Description

This abstract class represents a user or group and contains methods common to both.

## Member Function Documentation

override string TIBCO.EMS.ADMIN.PrincipalInfo.ToString | ( |  | ) |
| inline

Generate a string representation of this PrincipalInfo.

Returns
  a string representation of this PrincipalInfo.

## Property Documentation

string TIBCO.EMS.ADMIN.PrincipalInfo.Description
| get set

Get or set the description of this user or group.

Returns
  the description of this user or group.

If the user or group is external then it is an error to attempt to change its description.

Exceptions

  AdminException | if the user or group is external.

bool TIBCO.EMS.ADMIN.PrincipalInfo.External
| get

Indicates whether or not this user or group is external.

Users and groups that are defined in an external repository such as an LDAP server are external whereas those defined in users.conf or groups.conf are not.

Returns
  true if the user or group is external, false otherwise.

string TIBCO.EMS.ADMIN.PrincipalInfo.Name
| get

Get the name of this user or group.

Returns
  the name of this user or group.